API keys

API keys authenticate the CLI, SDKs, and REST API. Each key belongs to one organization and starts with axl_. Listing, creating, and deleting API keys requires an organization admin.

Create a key

Dashboard
CLI
Python SDK
Go SDK
REST API

Open API Keys after choosing your organization.
Click Create Key.
Enter a name and create the key.
Copy the secret before closing the dialog.

axilio api-keys create ci-bot

Add -o json for structured output.

key = client.api_keys.create(name="ci-bot")
print(key.id, key.key_value)

key, err := api.APIKeys.Create(ctx, &platformgo.APIKeyCreateRequest{
    Name: "ci-bot",
})
if err != nil {
    log.Fatal(err)
}
fmt.Println(key.ID, key.KeyValue)

REST API References:

Create an API key: POST /api-keys

Examples use Bash. To run them in PowerShell, see Run the curl examples on Windows.

curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.axilio.ai/api/v1/api-keys \
  --header "X-Axilio-Api-Key: $AXILIO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"ci-bot"}'

Axilio returns the full key_value once, when you create the key. Store it in a secret manager. List operations return only a masked preview.

List keys

Dashboard
CLI
Python SDK
Go SDK
REST API

Open API Keys to search by name or preview and inspect creator, last-used time, and creation time.

axilio api-keys list

keys = client.api_keys.list(limit=50)

for key in keys.api_keys or []:
    print(key.id, key.name, key.key_preview, key.last_used_at)

keys, err := api.APIKeys.List(ctx, &platformgo.APIKeysListRequest{
    Limit: platformgo.Int64(50),
})

REST API References:

List API keys: GET /api-keys

Examples use Bash. To run them in PowerShell, see Run the curl examples on Windows.

curl --silent --show-error --fail-with-body \
  --url "https://api.axilio.ai/api/v1/api-keys?limit=50" \
  --header "X-Axilio-Api-Key: $AXILIO_API_KEY"

Replace or delete a key

There is no regenerate operation. Create the replacement, update and verify every consumer, then delete the old key.

Dashboard
CLI
Python SDK
Go SDK
REST API

Open API Keys, then create and save the replacement key.
Update every consumer and verify it can authenticate.
Select the old key, click Delete, and confirm.

axilio api-keys create replacement
# Save the secret and move consumers before continuing.
axilio api-keys delete key_123 --yes

replacement = client.api_keys.create(name="replacement")
print(replacement.key_value)

# Move and verify consumers before deleting the old key.
client.api_keys.delete("key_123")

replacement, err := api.APIKeys.Create(ctx, &platformgo.APIKeyCreateRequest{
    Name: "replacement",
})
if err != nil {
    log.Fatal(err)
}

_, err = api.APIKeys.Delete(ctx, &platformgo.APIKeysDeleteRequest{
    KeyID: "key_123",
})

REST API References:

Create an API key: POST /api-keys
Delete an API key: DELETE /api-keys/{key_id}

Examples use Bash. To run them in PowerShell, see Run the curl examples on Windows.

curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.axilio.ai/api/v1/api-keys \
  --header "X-Axilio-Api-Key: $AXILIO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"replacement"}'

# Save the new secret, migrate every consumer, and verify authentication.

curl --silent --show-error --fail-with-body \
  --request DELETE \
  --url https://api.axilio.ai/api/v1/api-keys/key_123 \
  --header "X-Axilio-Api-Key: $AXILIO_API_KEY"

Deleting a key takes effect for subsequent requests. Do not delete the credential currently running an unattended migration until the replacement is confirmed.

Get Started

Phones and Sessions

Workflows and Runs

Files

Observability

Telemetry

Usage

Billing

Organization

Reference

Create a key

List keys

Replace or delete a key

Next steps

Authentication

Organizations

​Create a key

​List keys

​Replace or delete a key

​Next steps

Authentication

Organizations

Create a key

List keys

Replace or delete a key

Next steps