IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete API keyedit
Delete or invalidate the API key.
Requestedit
DELETE /api/v1/users/auth/keys/{api_key_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The API Key ID. |
Responsesedit
-
200
-
The API key is deleted.
-
404
-
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
-
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 exampleedit
curl -XDELETE https://{{hostname}}/api/v1/users/auth/keys/{api_key_id} \ -H "Authorization: ApiKey $ECE_API_KEY"