Revoke an API key

Revoke a key. Effective on the next request.

DELETE/api/v1/keys/{key_id}

Request

curl -X DELETE https://api.beaconbox.eu/api/v1/keys/key_8ht2p1wd4n \
  -H "Authorization: Bearer $BEACONBOX_API_KEY"

curl -X DELETE https://api.beaconbox.eu/api/v1/keys/key_8ht2p1wd4n \
  -H "Authorization: Bearer $BEACONBOX_API_KEY"

client.keys.revoke(key_id)

client.keys.revoke(key_id)

$client->keys->revoke($keyId)

$client->keys->revoke($keyId)

Path parameters

Name	Type	Description
`key_id`	`string`

Response

Returns 204 with no body.

Errors

Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.