Disable an API key
Disables an API key. While disabled, presenting the key’s token fails authentication on every endpoint; the key is retained. Idempotent.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The workspace the API key belongs to (path).
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
The API key to disable.
"apikey_01HXKD2E5NQM3T9AYWCFCSPNQY"
Body
The body is of type object.
Response
OK
An API key. Every key belongs to exactly one workspace and is managed via the workspace-scoped API key routes. The only exception is the system-managed global account key, which spans all workspaces and is managed via the account global_api_key routes.
AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.
Configuration for an API key.
The current lifecycle state of the API key. Output only. Keys are created STATE_ENABLED; use the :disable and :enable actions to transition between states.
STATE_UNSPECIFIED, STATE_ENABLED, STATE_DISABLED