Admin API

Account

Read the signed-in user's profile and memberships, and change their display name.

Any signed-in user can read their own profile: display name, email, staff role if any, and every workspace they belong to with their role there. The only field they can change is their display name.

Operations

Operation	Request	Who may call it
getMe	GET /v1/me	any signed-in user
updateMe	PATCH /v1/me	any signed-in user

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.

More api areas

All api areas →

01
Workspaces
List, create and rename workspaces, and set a workspace’s ingest rate limit.
02
Members
Add members to a workspace, change their role or remove them.
03
Sources
Create sources, rotate their write keys and revoke previous keys.

Operations

More api areas

Workspaces

Members

Sources