Skip to content
pipeo
Menu

Admin API

Sources

Create sources, rotate their write keys and revoke previous keys.

A source is where events come from, identified by its write key. The key is shown once at creation; only its hash and prefix are stored.

Rotating a key keeps the previous one valid for a grace period (24 hours by default), and previous keys can be revoked early. Disabling a source makes ingest refuse its events.

Operations

OperationRequestWho may call it
listSourcesGET /v1/workspaces/{ws}/sourcesviewer or above; staff: super, support
createSourcePOST /v1/workspaces/{ws}/sourcesadmin
deleteSourceDELETE /v1/workspaces/{ws}/sources/{id}admin
updateSourcePATCH /v1/workspaces/{ws}/sources/{id}editor or above
revokePreviousKeysDELETE /v1/workspaces/{ws}/sources/{id}/previous-keysadmin
rotateSourceKeyPOST /v1/workspaces/{ws}/sources/{id}/rotate-keyadmin

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.