Skip to content
pipeo
Menu

Admin API

Connections

Join a source to a destination, with an event filter and dropped fields.

A connection routes one source to one destination. It can be switched off, can pass only some event types or track event names, and can remove fields before delivery.

Editors manage connections; viewers and support staff can read them.

Operations

OperationRequestWho may call it
listConnectionsGET /v1/workspaces/{ws}/connectionsviewer or above; staff: super, support
createConnectionPOST /v1/workspaces/{ws}/connectionseditor or above
deleteConnectionDELETE /v1/workspaces/{ws}/connections/{sourceId}/{destinationId}editor or above
updateConnectionPATCH /v1/workspaces/{ws}/connections/{sourceId}/{destinationId}editor or above

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.