IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get all API keys for all users Get API key »

› › › ›

Delete API key

edit

Delete API key

edit

Delete or invalidate the API key.

Request

edit

DELETE /api/v1/users/auth/keys/{api_key_id}

Path parameters

edit

Name	Type	Required	Description
`api_key_id`	`string`	Y	The API Key ID.

Responses

edit

200

(EmptyResponse)

The API key is deleted.

404

(BasicFailedReply)

The {api_key_id} can't be found. (code: api_keys.key_not_found)

Headers

x-cloud-error-codes (string; allowed values: [api_keys.key_not_found]): The error codes associated with the response

449

(BasicFailedReply)

Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]): The error codes associated with the response

Request example

edit

curl -XDELETE https://{{hostname}}/api/v1/users/auth/keys/{api_key_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Get all API keys for all users Get API key »