Skip to main content
POST
Create ingest token

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

write

Grants write access

Body

application/json

Create an ingest token for an existing telemetry feed. Save plaintext_token securely; it is returned only once.

feed_token
string
required

The public token of an existing telemetry feed.

name
string

An optional name, up to 100 characters.

expires_at
string<date-time>

Expiration time in ISO 8601 format. Defaults to 18 months; must be in the future and no more than 18 months away.

retention_days
integer<int32>

An optional positive retention period in days.

Response

Create an ingest token for an existing telemetry feed. Save plaintext_token securely; it is returned only once.

IngestTokenCreation model

token
string
required

The public identifier for this token, not the secret ingest credential.

feed_token
string
required

The public token of the telemetry feed this token belongs to.

provider
string
required

The telemetry provider for this token.

name
string | null
required

The token name.

last4
string
required

The last four characters of the secret ingest credential.

retention_days
integer<int32> | null
required

The retention period in days, when specified.

issued_at
string
required

When the token was issued, in ISO 8601 format.

expires_at
string
required

When the token expires, in ISO 8601 format.

revoked_at
string | null
required

When the token was revoked, in ISO 8601 format.

created_by
string | null
required

The public token of the user who created this ingest token, when available.

plaintext_token
string
required

The secret ingest credential. Returned only on creation; save it securely.