Skip to content
Boltz Boltz Boltz API Docs
Go to Boltz API
API Reference
Admin
API Keys

List API keys

admin.api_keys.list(APIKeyListParams**kwargs) -> SyncCursorPage[APIKeyListResponse]
GET/compute/v1/admin/api-keys

List API keys

ParametersExpand Collapse
after_id: Optional[str]

Return results after this ID

before_id: Optional[str]

Return results before this ID

limit: Optional[int]

Max items to return

minimum1
maximum100
workspace_id: Optional[str]

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

ReturnsExpand Collapse
class APIKeyListResponse: …
id: str

API key ID

allowed_ips: List[str]

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

created_at: datetime
formatdate-time
expires_at: Optional[datetime]

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

formatdate-time
is_active: bool
key_prefix: str

First 12 characters of the key

key_type: Literal["admin", "workspace"]
Accepts one of the following:
"admin"
"workspace"
last_used_at: Optional[datetime]
formatdate-time
livemode: bool

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

name: str

API key name

workspace_id: Optional[str]

Workspace ID if workspace-scoped

List API keys

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
page = client.admin.api_keys.list()
page = page.data[0]
print(page.id)
{
  "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"
}