Sign in
api-keys

Revoke API key

Revokes an API key so it can no longer authenticate. The key remains visible as inactive.

delete/api/api-keys/{key_id}

Path parameters

key_idstring required

ID of the API key to revoke

ID of the API key to revoke

Response

Successful Response

DeletionResponse required

Empty acknowledgment returned when an operation succeeds.

Changes

Changed in 4 of the 79 revisions of this API.28

  • 815e0302a98811See the full diff
    • ▲

      response property detail list-of-types was widened by adding types string to media type application/json of response 422

      response-property-list-of-types-widened

    • ○

      the response property detail became required for the status 422

      response-property-became-required

  • c3e15c78f2da4See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • 6397cb5a99c52See the full diff
    • ○

      api operation id delete_api_key_api_api_keys__key_id__delete removed and replaced with delete_api_key

      api-operation-id-removed

    • ○

      the endpoint scheme security clerkSession was added to the API

      api-security-added

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

  • 9af798cdc7db11See the full diff
    • ▲

      removed the success response with the status 204

      response-success-status-removed

    • ○

      added the success response with the status 200

      response-success-status-added