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.

Update Route

PATCH /v1/routes/:id
Updates one or more fields on an existing route. Only include the fields you want to change.

Path Parameters

ParameterTypeDescription
iduuidThe route ID

Request Body

All fields are optional. Only provided fields will be updated.
FieldTypeDescription
namestringDisplay name
enabledbooleanEnable or disable the route
requires_clientsbooleanWhether requests must come from an authorized client
target_base_urlstringUpstream API base URL
inject_headers_jsonobjectHeaders to inject
inject_body_jsonobjectBody fields to inject
method_configsobjectPer-HTTP-method configuration
injection_rulesobject[]Advanced injection rules
require_signaturebooleanRequire request signature validation
signature_tolerance_secnumberSignature timestamp tolerance in seconds
rate_limit_enabledbooleanEnable rate limiting
rate_limit_requestsnumberMax requests per window
rate_limit_window_secnumberRate limit window in seconds
rate_limit_burstnumberBurst allowance
allowed_methodsstring[]Restrict to specific HTTP methods
http_method_restrictions_enabledbooleanEnable method restrictions
egress_server_idstringRoute through a specific egress/VPN server
ip_allowliststring[]Allowed IP addresses or CIDR ranges
data_plane_node_idstringAssign to a specific data plane node

Response

Returns the updated route object.

Errors

StatusTypeDescription
400validation_errorNo valid fields provided
404not_foundRoute not found