Skip to main content
POST
JavaScript
The reverse of disable. The key returns to STATE_ENABLED and the token it already had starts working again: nothing is reissued, so consumers holding the token need no update.
Idempotent: enabling an enabled key returns 200 and changes nothing.
If the key was disabled because its token may have leaked, prefer rotate over enable. Enable revives the possibly-leaked token; rotate replaces it.

Disable an API key

The switch this undoes, and when to use which.

Rotate an API key

Reissue instead of revive.

Authorizations

Authorization
string
header
required

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

Path Parameters

workspaceId
string
required

The workspace the API key belongs to (path).

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

id
string
required

The API key to enable.

Example:

"apikey_01HXKD2E5NQM3T9AYWCFCSPNQY"

Body

application/json

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.

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