Revoke API Key

Warning: This API has been deprecated. Please contact us to move to the latest Authentication system and transition to using Service Accounts.

DELETE /api-keys/{APIKeyId}/

Revokes an APIKey by its id.

Required Permissions

ApiKeys:Revoke

Parameters

Path parameters

Path parameterDescription

APIKeyId

Unique identifier of the APIKey like: api-orange-magnesium-a0606d08b2

Request example

Sample request

curl -X DELETE "/api-keys/api-orange-magnesium-a0606d08b2" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <TOKEN>" \

Response

Response example

{
  "id": "api-cat-freddie-a150fe2ce0",
  "name": "My API Key",
  "orgId": "cu-purple-pip-1b417b958500",
  "status": "Revoked",
  "authorId": "ce-finch-march-5b59fcbb571b",
  "dateCreated": "2022-09-01T09:06:32.567Z",
}

Last updated