API Keys
Revoke an API key
Revoke an API key by its ID. The key will immediately stop working for authentication. Revoking an already-revoked key is a no-op and still returns 204.
Authorization:
-
User keys: The key's creator or an account admin may revoke the key.
-
Service keys: Account admins and space admins in all of the key's bound spaces may revoke the key regardless of who created it. All other callers must have the SERVICE_KEY_REVOKE permission in every bound space and must be the key's creator. Callers without read access to the key receive 404 to prevent key-ID enumeration.
<Note>This endpoint is in beta, read more here.</Note>
put/v2/api-keys/{api_key_id}/revoke
Path parameters
api_key_idstring required
A universally unique identifier (base64-encoded opaque string).
Example:RW50aXR5OjEyMzQ1
The unique API key identifier (base64)
Response
API key successfully revoked