Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Creates a new route in your tenant
POST /v1/routes
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name for the route |
target_base_url | string | Yes | The upstream API base URL to proxy requests to |
base_environment | string | No | Default environment (defaults to production) |
inject_headers_json | object | No | Headers to inject into proxied requests |
inject_body_json | object | No | Body fields to inject into proxied requests |
injection_rules | object[] | No | Advanced injection rules for secrets |
ip_allowlist | string[] | No | IP addresses or CIDR ranges allowed to call this route |
method_configs | object | No | Per-HTTP-method configuration overrides |
collection_id | string | No | Assign to a collection |
routes table row, including all columns). Note this differs from the Get Route response, which returns a projected shape with additional derived fields (environment_override_count, payload_structure, injection_rules, ip_allowlist, data_plane_node_id, and configured_environments) that are not included here. Call Get Route to retrieve those fields.
curl -X POST https://api.knoxcall.com/v1/routes \
-H "Authorization: Bearer tk_live_abc123..." \
-H "Content-Type: application/json" \
-d '{
"name": "Payment Gateway",
"target_base_url": "https://api.stripe.com/v1"
}'
import requests
resp = requests.post(
"https://api.knoxcall.com/v1/routes",
headers={
"Authorization": "Bearer tk_live_abc123...",
"Content-Type": "application/json"
},
json={
"name": "Payment Gateway",
"target_base_url": "https://api.stripe.com/v1"
}
)
route = resp.json()
const resp = await fetch("https://api.knoxcall.com/v1/routes", {
method: "POST",
headers: {
Authorization: "Bearer tk_live_abc123...",
"Content-Type": "application/json"
},
body: JSON.stringify({
name: "Payment Gateway",
target_base_url: "https://api.stripe.com/v1"
})
});
const route = await resp.json();
| Status | Type | Description |
|---|---|---|
| 400 | validation_error | Missing required fields or invalid environment |
| 403 | plan_limit | Route limit reached for your subscription plan |
| 409 | conflict | A route with this name already exists |
Was this page helpful?