Sign in
API Keys

Delete API Key

Permanently revokes an API key; requests using its secret stop authenticating immediately. Default and agent-backend keys cannot be deleted.

delete/api_keys/{id}

Response

api key deleted

deletedboolean required

Always true: the key was revoked.

idstring required

The ID of the revoked key.

Example response

{
  "deleted": true,
  "id": "apik_xxxxxxxxxxxxxx"
}

Changes

Changed in 2 of the 74 revisions of this API.5

  • f1020c3ecda44See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.