API keys

Revoke an API key

Idempotent: revoking an already-revoked key returns the same body, so a rotation script that re-runs does not have to special-case having already succeeded. An OAuth member may revoke a key they created; an organization admin may revoke any key. Organization API keys retain account-wide authority.

DELETE
/api_keys/{api_key_id}

Idempotent: revoking an already-revoked key returns the same body, so a rotation script that re-runs does not have to special-case having already succeeded. An OAuth member may revoke a key they created; an organization admin may revoke any key. Organization API keys retain account-wide authority.

AuthorizationBearer <token>

Organization API key from the console (ak_...), or an OAuth access token with user:org:read, the organization selected during consent, and the capability required by the operation.

In: header

Path Parameters

api_key_id*string

Identifier returned by the API key list.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api_keys/string"
{  "id": "string",  "object": "api_key",  "name": "string",  "last4": "string",  "revoked": true,  "last_used_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}