Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Returns the full configuration for a single route
GET /v1/routes/:id
payload_structure is the base environment’s saved sample request body as its structure only: the same keys and nesting, with every value replaced by a type placeholder ("<string>", "<number>", "<boolean>"; null stays null). The sample’s values are never returned by the API — a saved sample is usually a captured request, so its values are a recorded reveal for an Admin or the Owner in the dashboard.
| Parameter | Type | Description |
|---|---|---|
id | uuid | The route ID |
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Payment Gateway",
"target_base_url": "https://api.stripe.com/v1",
"base_environment": "production",
"enabled": true,
"requires_clients": false,
"methods": null,
"mtls_certificate_id": null,
"collection_id": null,
"created_at": "2026-01-15T09:30:00.000Z",
"environment_override_count": 2,
"payload_structure": {
"order": { "id": "<string>", "amount": "<number>", "paid": "<boolean>" }
},
"injection_rules": null,
"ip_allowlist": null,
"data_plane_node_id": null,
"configured_environments": ["production", "staging"]
},
"meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}
| Status | Type | Description |
|---|---|---|
| 404 | not_found | Route not found |
Was this page helpful?