Skip to main content
PUT
/
api
/
api-keys
/
{id}
/
revoke
Revoke an API key
curl --request PUT \
  --url https://api.example.com/api/api-keys/{id}/revoke \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
{
  "id": 1,
  "revoked": true
}

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

API key ID

Response

200 - application/json

API key revoked

​
id
number
required

API key ID

Example:

1

​
revoked
boolean
required

Whether the API key was revoked

Example:

true