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.
Authorizations
Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.
Path Parameters
1Response
The revoked key metadata.
Unique id of the API key.
Human-readable label, 1–200 characters.
Id of the organization that owns the key.
Access configuration of an API key: either one organization-wide role, or one role across an explicit set of websites. The owner role can never be granted to an API key.
- Option 1
- Option 2
When the key stops authenticating. null when it never expires.
When the key was revoked. null while the key is active.
When the key was created.