Revoke an API key

$ boltz-api admin:api-keys revoke

POST/compute/v1/admin/api-keys/{api_key_id}/revoke

Revoke an API key

ParametersExpand Collapse

--api-key-id: string

ReturnsExpand Collapse

AdminAPIKeyRevokeResponse: object { id, allowed_ips, created_at, 8 more }

id: string

API key ID

allowed_ips: array of string

IP addresses allowed to use this key. An empty array means all IPs are allowed.

created_at: string

formatdate-time

expires_at: string

When the key expires. Null if the key does not expire.

formatdate-time

is_active: boolean

key_prefix: string

First 12 characters of the key

key_type: "admin" or "workspace"

Accepts one of the following:

"admin"

"workspace"

last_used_at: string

formatdate-time

livemode: boolean

Whether this is a live API key (false for test keys).

name: string

API key name

workspace_id: string

Workspace ID if workspace-scoped

Revoke an API key

boltz-api admin:api-keys revoke \
  --api-key-id api_key_id

{
  "id": "id",
  "allowed_ips": [
    "string"
  ],
  "created_at": "2019-12-27T18:11:19.117Z",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "is_active": true,
  "key_prefix": "key_prefix",
  "key_type": "admin",
  "last_used_at": "2019-12-27T18:11:19.117Z",
  "livemode": true,
  "name": "name",
  "workspace_id": "workspace_id"
}

Returns Examples

{
  "id": "id",
  "allowed_ips": [
    "string"
  ],
  "created_at": "2019-12-27T18:11:19.117Z",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "is_active": true,
  "key_prefix": "key_prefix",
  "key_type": "admin",
  "last_used_at": "2019-12-27T18:11:19.117Z",
  "livemode": true,
  "name": "name",
  "workspace_id": "workspace_id"
}