Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Creates a new authorized client
POST /v1/clients
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name for the client |
ip_address | string | Yes | IP address or CIDR range (e.g., 203.0.113.42 or 10.0.0.0/16) |
type | string | No | Client type: user or server (defaults to server) |
ip_notes | object | No | Metadata about the IP address |
description | string | No | Human-readable description |
route_assignments array (route assignments only appear on GET /v1/clients/:id) and includes the raw tenant_id column.
curl -X POST https://api.knoxcall.com/v1/clients \
-H "Authorization: Bearer tk_live_abc123..." \
-H "Content-Type: application/json" \
-d '{
"name": "Production Backend",
"ip_address": "203.0.113.0/24",
"type": "server",
"description": "Main backend servers"
}'
import requests
resp = requests.post(
"https://api.knoxcall.com/v1/clients",
headers={
"Authorization": "Bearer tk_live_abc123...",
"Content-Type": "application/json"
},
json={
"name": "Production Backend",
"ip_address": "203.0.113.0/24",
"type": "server",
"description": "Main backend servers"
}
)
client = resp.json()
const resp = await fetch("https://api.knoxcall.com/v1/clients", {
method: "POST",
headers: {
Authorization: "Bearer tk_live_abc123...",
"Content-Type": "application/json"
},
body: JSON.stringify({
name: "Production Backend",
ip_address: "203.0.113.0/24",
type: "server",
description: "Main backend servers"
})
});
const client = await resp.json();
| Status | Type | Description |
|---|---|---|
| 400 | validation_error | Missing required fields or invalid type |
| 403 | plan_limit | Client limit reached for your subscription plan |
Was this page helpful?