List API keys

$ boltz-api admin:api-keys list

GET/compute/v1/admin/api-keys

List API keys

ParametersExpand Collapse

--after-id: optional string

Return results after this ID

--before-id: optional string

Return results before this ID

--limit: optional number

Max items to return

minimum1

maximum100

--workspace-id: optional string

Filter by workspace ID. If not provided, returns keys across all workspaces.

ReturnsExpand Collapse

ListApiKeysResponse: object { data, first_id, has_more, last_id }

data: array of 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

first_id: string

ID of the first item. Use as before_id for the previous page.

has_more: boolean

last_id: string

ID of the last item. Use as after_id for the next page.

List API keys

boltz-api admin:api-keys list

{
  "data": [
    {
      "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"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Returns Examples

{
  "data": [
    {
      "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"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}