Sign in
API Keys

Delete an API key

Deletes an API key. Delete a key when it is no longer needed or when it is compromised.

Users that hold none of the corpus_administrator, administrator, or owner roles can only delete their own personal API key; a key that exists but belongs to another user returns a 404 error. Machine credentials — API keys, app clients, and service accounts — without one of those three roles cannot call this operation.

delete/v2/api_keys/{api_key_id}

Path parameters

api_key_idstring required

The ID of the API key.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The API key was deleted.

Changes

Changed in 1 of the 7 revisions of this API.1