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

Create a workspace API key

admin.api_keys.create(APIKeyCreateParams**kwargs) -> APIKeyCreateResponse
POST/compute/v1/admin/api-keys

Create a workspace API key

ParametersExpand Collapse
name: str

API key name

minLength1
maxLength255
allowed_ips: Optional[SequenceNotStr[str]]

IP addresses allowed to use this key (IPv4 or IPv6). An empty array (the default) means all IPs are allowed.

expires_in_days: Optional[int]

Days until the key expires. Omit for a key that does not expire.

minimum1
maximum365
mode: Optional[Literal["live", "test"]]

Key mode. Test keys create test-mode resources with synthetic data.

Accepts one of the following:
"live"
"test"
workspace_id: Optional[str]

Workspace ID to scope this key to. Omit for default workspace.

ReturnsExpand Collapse
class APIKeyCreateResponse: …
key: str

The full API key. This is only shown once — store it securely.

key_details: KeyDetails
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["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: str

Workspace this key is scoped to

Create a workspace API key

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
)
api_key = client.admin.api_keys.create(
    name="x",
)
print(api_key.key)
{
  "key": "key",
  "key_details": {
    "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": "workspace",
    "last_used_at": "2019-12-27T18:11:19.117Z",
    "livemode": true,
    "name": "name",
    "workspace_id": "workspace_id"
  }
}
Returns Examples
{
  "key": "key",
  "key_details": {
    "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": "workspace",
    "last_used_at": "2019-12-27T18:11:19.117Z",
    "livemode": true,
    "name": "name",
    "workspace_id": "workspace_id"
  }
}