Skip to main content
POST
Python SDK

Access

This operation needs a Parable token. An MCP token cannot call it. See Authentication for the kinds of token. Your roles must grant tenant.connectors.taps.write.

Errors

  • WA-IGT-002: The Tap is not in this Workspace. Choose a Tap from the selected Workspace.
  • WA-IGT-003: The Tap already has a live ingestion token. Rotate the live token instead.

Authorizations

Authorization
string
header
required

A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Input for minting a new ingest token. The tap must belong to the calling workspace; the service layer enforces this before minting.

tenantConnectorTapId
string
required

The collector provider connection this token routes to.

Pattern: ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Successful response

data
object
required

Result of mintIngestToken and rotateIngestToken. The plaintext token is returned exactly once and is irrecoverable afterwards — clients must surface it (and the endpointUrl embedding it) to the user immediately and never re-fetch.

meta
object
required