Revoke API Key
Revokes an API key by its ID, so it can no longer be used. This action is irreversible.
The key stops working immediately and drops out of GET /v1/keys, but the
record is retained with when it was revoked and by whom.
Requirements:
- Key must belong to the authenticated user’s workspace
Key Features:
- Permanently revoke API key access while retaining the audit record
- Idempotent operation (safe to retry)
- Optional Idempotency-Key header for safe retries
Important:
- This action cannot be undone
- Any applications using this key will immediately lose access
- Returns 204 even if the key doesn’t exist or is already revoked
Common Use Cases:
- Revoke compromised keys
- Clean up unused keys
- Implement key rotation (revoke old, create new)
- Offboard team members
Required permissions: auth:keys:write. Key presets that include them: FULL. See key permissions.
Authorizations
Key on the FULL preset, or any key whose permissions include the ones this API lists. Prefix it with "Key ", e.g. Authorization: Key YOUR_API_KEY
Headers
Optional idempotency key for safe request retries
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
Unique identifier of the API key to revoke
1"abc123def456"
Response
API key revoked successfully (or already revoked)