DELETE/api/admin/api-keys/{api_key_id}Admin

Revoke an API key

operationId revokeApiKeyAdmin: API Keys

Authentication & permissionsAdmin

Platform administrators only

Accepted credentials: Access token (Bearer)Authorization: Bearer <JWT>
Access token (cookie)cookie "access_token_schemavaults-mail"
Who may call: Platform administrators only

Path parameters

Name	Type	Description
api_key_id*	string (uuid)	ID of the API key.

Responses

application/json

SuccessMessageResponseSuccess envelope for operations with no response payload.

Property	Type	Description
success*	true
message*	string

JSONExample

"success"true

"message""string"

Example request

bashcurl

curl -X DELETE 'https://mail.schemavaults.com/api/admin/api-keys/<api_key_id>' \
  -H 'Authorization: Bearer <access_token>'

Other methods on this path

PATCHUpdate an API key

SchemaVaults

API Reference

Revoke an API key

Authentication & permissionsAdmin

Path parameters

Responses

Example request

Other methods on this path

SchemaVaults

API Reference

Revoke an API key

Authentication & permissionsAdmin

Path parameters

Responses

Example request

Other methods on this path

Authentication & permissionsAdmin

Path parameters

Responses

200The key was revoked.

400The path parameters, query string, headers or body failed validation.

401No credential was presented, or the presented credential is invalid, expired or revoked.

403The caller is authenticated but is not a platform administrator.

500Failed to revoke the API key.

Example request

Other methods on this path

Authentication & permissionsAdmin

Path parameters

Responses

200The key was revoked.

400The path parameters, query string, headers or body failed validation.

401No credential was presented, or the presented credential is invalid, expired or revoked.

403The caller is authenticated but is not a platform administrator.

500Failed to revoke the API key.

Example request

Other methods on this path