Revoke API Key via API

This method allows you to revoke an existing API key for the currently authenticated user.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/security/api_keys/:identifier

HTTP Method

DELETE

Supported Parameters

This endpoint does not accept any parameters. The API key identifier is specified in the URL.

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-X DELETE \
https://test.deployhq.com/security/api_keys/b2c3d4e5-6f78-9012-abcd-ef3456789012

Example Response

A successful revocation returns an HTTP 200 status:

{
  "status": "ok"
}

Notes

• The :identifier in the URL is the UUID of the API key to revoke
• Once revoked, the API key can no longer be used for authentication
• This action is irreversible - you will need to create a new key if needed
• You cannot revoke the API key that is currently being used to authenticate the request