Skip to main content
DELETE
Revoke API Key
Revoke an API key, preventing it from being used for future requests. Revoked keys remain in the list but with status: revoked.

Headers

string
required
Bearer token from Cognito authentication (JWT).
string
required
The organization ID.

Path Parameters

string
required
The unique identifier of the API key (format: apikey_[a-f0-9]{12}).

Permissions

  • Only admin and agent_manager roles can revoke API keys.
  • You cannot revoke a key with a higher role than your own.

Response

boolean
Indicates if the request was successful.
string
Human-readable success message.
object
The revoked API key object.

Error Responses

Returned when the caller does not have permission to revoke API keys or is trying to revoke a key with a higher role than their own.
Returned when the API key does not exist or does not belong to the current organization.