API keys

Revoke an API key

Permanently deactivates the key by setting revokedAt; requests that use it fail with 401 immediately. Revocation is irreversible — rotate instead if the key should keep working with a new secret. Revoking an already-revoked key is a no-op that returns the current metadata.

post/apiKeys/{apiKeyId}/revoke

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/apiKeys/{apiKeyId}/revoke
  • Auth: HTTP bearer

Path parameters

apiKeyIdstring required

Response

The revoked key metadata.

idstring required

Unique id of the API key.

namestring required

Human-readable label, 1–200 characters.

organizationIdstring required

Id of the organization that owns the key.

expiresAtstring date-time nullable required

When the key stops authenticating. null when it never expires.

revokedAtstring date-time nullable required

When the key was revoked. null while the key is active.

createdAtstring date-time required

When the key was created.

Changes

No recorded changes to this operation across all 1 revision of this API.