v1

latestOpenAPI 3.0.32026-08-0670174396.8 KB

API Keys

Update API key

Update an API key's label, active status, expiration date, or scopes. Pass null for expires_at to remove expiration.

patch/public/v1/accounts/tokens/{token_id}/

token_idinteger required

namestring

Human-readable label for the token, shown in the token list.

activeboolean

Set to false to deactivate the token, or true to reactivate it.

expires_atstring date-time nullable

Expiration timestamp (ISO 8601). Pass null to remove the expiration and make the token non-expiring.

scopesstring[]

Replacement list of scopes for the token. Available value: all.

idinteger required

Unique identifier for the API key token.

namestring required

Human-readable label for the token.

scopesstring[] required

Scopes granted to the token.

activeboolean required

Whether the token is currently active.

expires_atstring date-time nullable

Expiration timestamp, or null if the token never expires.

tokenstring

The API key value used as the Bearer credential. Returned in full on every read.

created_atstring date-time required

When the token was created.

last_used_atstring date-time nullable

When the token was last used to authenticate a request, or null if never used.