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)

449

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XDELETE {{hostname}}/api/v1/users/auth/keys/{api_key_id} \
-u $CLOUD_USER:$CLOUD_KEY