Skip to content
pipeo
Menu

Admin API

Workspaces

List, create and rename workspaces, and set a workspace’s ingest rate limit.

A workspace is the tenant: it owns sources, destinations, connections and members, and Postgres row-level security keeps its rows apart from every other workspace.

Members read their own workspace, and its admins rename it. Staff accounts list every workspace; only a super staff account creates one or sets its ingest rate limit (events per second).

Operations

OperationRequestWho may call it
listWorkspacesGET /v1/workspacesstaff: super, support
createWorkspacePOST /v1/workspacesstaff: super
getWorkspaceGET /v1/workspaces/{ws}viewer or above; staff: super, support
updateWorkspacePATCH /v1/workspaces/{ws}staff: super
updateWorkspaceSettingsPATCH /v1/workspaces/{ws}/settingsadmin

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.