Update Route
Updates one or more fields on an existing route
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Updates one or more fields on an existing route
PATCH /v1/routes/:id
| Parameter | Type | Description |
|---|---|---|
id | uuid | The route ID |
| Field | Type | Description |
|---|---|---|
name | string | Display name |
enabled | boolean | Enable or disable the route |
requires_clients | boolean | Whether requests must come from an authorized client |
target_base_url | string | Upstream API base URL |
inject_headers_json | object | Headers to inject |
inject_body_json | object | Body fields to inject |
method_configs | object | Per-HTTP-method configuration |
injection_rules | object[] | Advanced injection rules |
require_signature | boolean | Require request signature validation |
signature_tolerance_sec | number | Signature timestamp tolerance in seconds |
rate_limit_enabled | boolean | Enable rate limiting |
rate_limit_requests | number | Max requests per window |
rate_limit_window_sec | number | Rate limit window in seconds |
rate_limit_burst | number | Burst allowance |
allowed_methods | string[] | Restrict to specific HTTP methods |
http_method_restrictions_enabled | boolean | Enable method restrictions |
egress_server_id | string | Route through a specific egress/VPN server |
ip_allowlist | string[] | Allowed IP addresses or CIDR ranges |
data_plane_node_id | string | Assign to a specific data plane node |
| Status | Type | Description |
|---|---|---|
| 400 | validation_error | No valid fields provided |
| 404 | not_found | Route not found |
Was this page helpful?