Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
List, set, and delete environment-specific configuration overrides for a route
GET /v1/routes/:id/environments
| Parameter | Type | Description |
|---|---|---|
id | uuid | The route ID |
{
"data": [
{
"environment_name": "staging",
"target_base_url": "https://api-staging.stripe.com/v1",
"inject_headers_json": {},
"inject_body_json": {},
"intercept_enabled": false,
"require_signature": false,
"signature_tolerance_sec": null,
"rate_limit_enabled": false,
"rate_limit_requests": null,
"rate_limit_window_sec": null,
"rate_limit_burst": null,
"allowed_methods": null
}
],
"meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}
| Status | Type | Description |
|---|---|---|
| 404 | not_found | Route not found |
PUT /v1/routes/:id/environments/:env
| Parameter | Type | Description |
|---|---|---|
id | uuid | The route ID |
env | string | Environment name (e.g., staging, development) |
target_base_url is required when the override does not exist yet (400 validation_error otherwise).
| Field | Type | Description |
|---|---|---|
target_base_url | string | Override upstream URL |
inject_headers_json | object | Override injected headers |
inject_body_json | object | Override injected body fields |
intercept_enabled | boolean | Opt this environment into route-aware interception. Turning it on is refused with 409 intercept_route_conflict when another intercept-enabled route already covers the same upstream host and base path in this environment. |
require_signature | boolean | Override signature requirement |
signature_tolerance_sec | number | Override signature tolerance |
rate_limit_enabled | boolean | Override rate limiting |
rate_limit_requests | number | Override max requests |
rate_limit_window_sec | number | Override window duration |
rate_limit_burst | number | Override burst allowance |
allowed_methods | string[] | Override allowed HTTP methods |
| Status | Type | Description |
|---|---|---|
| 400 | validation_error | Invalid environment name |
| 403 | forbidden | The route carries a standing decrypt or detokenize field action and this write would give it a destination it does not already store, or switch on one it stores but does not send to: a token issued to a person is refused whatever the role, and a key must hold the action’s own permission (transit:decrypt / vault:detokenize). See Moving a route that decrypts or detokenizes. |
| 403 | insufficient_scope | The same, for an OAuth token narrowed to scopes that do not include the action’s own (transit:decrypt / vaults:detokenize); the WWW-Authenticate header names it. |
| 404 | not_found | Route not found |
DELETE /v1/routes/:id/environments/:env
| Parameter | Type | Description |
|---|---|---|
id | uuid | The route ID |
env | string | Environment name |
{
"data": { "deleted": true },
"meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}
| Status | Type | Description |
|---|---|---|
| 404 | not_found | Route or environment config not found |
Was this page helpful?