Skip to navigation

Revoke a client token

View as Markdown

Revoke a client token immediately: it stops authenticating new connections.

A token only gates new connections. A call already in progress on a token that was revoked, replaced, or has expired continues until it hangs up; end it with DELETE /v1/sessions/{uuid}.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Path parameters

client_token_idstringRequiredformat: "^ct_[0-9a-f]{32}$"
Client token identifier.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. When a request has a valid traceparent, the server links the incoming context to its own trace and returns that trace identifier.

Response

The token was revoked.
client_token_idstring
The revoked token.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
500
Internal Server Error
503
Service Unavailable Error