Skip to main content
POST
JavaScript
The other half of the kill switch. The key returns to STATE_ENABLED and its existing token works again everywhere, so nothing downstream needs a new value.
Idempotent: enabling an enabled key returns 200 and changes nothing.
If the key was disabled over a suspected leak, rotate before or instead of enabling. Enable revives the token that worried you; rotate retires it.

Disable the global key

The switch this undoes.

Get the global key

Check its state and scopes.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.

metadata
object
required

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

spec
object
required

Configuration for an API key.

state
enum<string>
required
read-only

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.

Available options:
STATE_UNSPECIFIED,
STATE_ENABLED,
STATE_DISABLED
info
object