Sign in

v50

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-06-16122182589.7 KB
API Keys

Create an API key

Creates an API key for the authenticated account. Restrict access by listing permitted IP addresses in permitted_ips.

post/v1/api-keys

Request body

labelstring required

API key label.

activeboolean

Indicates whether the API key should be activated upon creation.

restrictedboolean

Indicates whether to restrict API key access by IP address. When enabled, only requests from IP addresses listed in permitted_ips are allowed.

permitted_ipsstring[]

List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when restricted is true.

scopes_enabledboolean

When true, scope fields below are enforced. When false (default), the key has full access. Omitted scope fields default to { allow: none }, so with scopes_enabled: true and no scopes set the key has no access.

Example request

{
  "label": "My API key",
  "active": true,
  "restricted": true,
  "permitted_ips": [
    "192.168.1.1",
    "10.0.0.1"
  ],
  "scopes_enabled": true,
  "numbers": {
    "allow": "read"
  },
  "trunks": {
    "allow": "read"
  },
  "calls": {
    "allow": "read"
  },
  "messages": {
    "allow": "read"
  },
  "recordings": {
    "allow": "read"
  },
  "campaigns": {
    "allow": "read"
  },
  "two_fa": {
    "allow": "read"
  },
  "validator": {
    "allow": "read"
  },
  "webhooks": {
    "allow": "read"
  },
  "embeddable": {
    "allow": "read"
  },
  "billing": {
    "allow": "read"
  },
  "account": {
    "allow": "read"
  },
  "subaccounts": {
    "allow": "read"
  }
}

Response

Returns the created API key.

idinteger required

API key ID.

labelstring required

API key label.

valuestring required

API key value.

activeboolean required

Indicates whether the API key is active.

restrictedboolean required

Indicates whether IP restrictions are enabled. When enabled, the API key works only from IP addresses in permitted_ips.

permitted_ipsstring[] required

List of permitted IP addresses. If restricted is false, an empty list means no IP restrictions. If restricted is true, an empty list prevents all requests.

scopes_enabledboolean required

When true, the key is restricted to the permissions defined in the scope fields below. When false, the key has full access.

last_used_atstring date-time nullable required

Timestamp of the most recent authenticated request made with this key.

created_atstring date-time required

Creation date and time in ISO 8601 format.

Example response

{
  "id": 123,
  "label": "Production API Key",
  "value": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
  "active": true,
  "restricted": true,
  "permitted_ips": [
    "192.168.1.1",
    "10.0.0.1"
  ],
  "scopes_enabled": true,
  "last_used_at": "2026-04-20T15:42:11Z",
  "numbers": {
    "allow": "read"
  },
  "trunks": {
    "allow": "read"
  },
  "calls": {
    "allow": "read"
  },
  "messages": {
    "allow": "read"
  },
  "recordings": {
    "allow": "read"
  },
  "campaigns": {
    "allow": "read"
  },
  "two_fa": {
    "allow": "read"
  },
  "validator": {
    "allow": "read"
  },
  "webhooks": {
    "allow": "read"
  },
  "embeddable": {
    "allow": "read"
  },
  "billing": {
    "allow": "read"
  },
  "account": {
    "allow": "read"
  },
  "subaccounts": {
    "allow": "read"
  },
  "created_at": "2024-01-15T10:30:00Z"
}