API
Admin API
Every console action is one named operation in a committed OpenAPI document, checked against a generated permission table.
This is the console’s API, not a public one: requests reach it only through the console’s server, for a signed-in user. There are no API keys for it yet. It is listed so you know what each action does and which role it needs.
- 01
Workspaces
5 operations. List, create and rename workspaces, and set a workspace’s ingest rate limit.
- 02
Members
4 operations. Add members to a workspace, change their role or remove them.
- 03
Sources
6 operations. Create sources, rotate their write keys and revoke previous keys.
- 04
Destinations
8 operations. Create destinations, update their settings and run connection tests.
- 05
Connections
4 operations. Join a source to a destination, with an event filter and dropped fields.
- 06
Audit events
2 operations. Read the audit log of a workspace, or across all workspaces for staff.
- 07
Account
2 operations. Read the signed-in user's profile and memberships, and change their display name.
- 08
Adapters and health
2 operations. List the destination types and their settings forms, and check the API is up.