Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.knoxcall.com/llms.txt

Use this file to discover all available pages before exploring further.

Create Client

POST /v1/clients
Creates a new authorized client.

Request Body

FieldTypeRequiredDescription
namestringYesDisplay name for the client
ip_addressstringYesIP address or CIDR range (e.g., 203.0.113.42 or 10.0.0.0/16)
typestringNoClient type: user or server (defaults to server)
ip_notesobjectNoMetadata about the IP address
descriptionstringNoHuman-readable description

Response

Returns the created client object (same shape as Get Client).
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"
  }'

Errors

StatusTypeDescription
400validation_errorMissing required fields or invalid type
403plan_limitClient limit reached for your subscription plan