Reference
Parameters, headers, and limits
Exact request conventions for API version 2026.08. All sizes use raw request bytes before upstream decompression.
Conventions
Resources use stable string identifiers with a short type prefix, such as svc_, rte_, and req_. Timestamps are UTC values in RFC 3339 format.
| Convention | Format | Example |
|---|---|---|
| Service ID | svc_{value} | svc_payments |
| Request ID | Sortable opaque ID | req_01J5D5W8R9F2 |
| Timestamp | RFC 3339 UTC | 2026-08-19T12:00:00Z |
| Currency | ISO 4217 | USD |
Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer token scoped to a workspace and environment. |
Content-Type | With body | Use application/json for management requests. |
Accept | No | Defaults to application/json. |
Idempotency-Key | For safe retries | Unique key, 8–128 ASCII characters, retained for 24 hours. |
X-Request-Id | No | Client correlation ID. The gateway generates one when omitted. |
X-Gateway-Version | No | Pin behavior to 2026-08; otherwise the workspace default applies. |
Forwarded headers: hop-by-hop headers are removed. The gateway sets
Forwarded and X-Forwarded-For from the trusted connection.List parameters
| Parameter | Type | Default | Rules |
|---|---|---|---|
limit | integer | 50 | 1–100 items. |
cursor | string | — | Opaque value from the prior response. |
sort | string | created_at | created_at, name, or status. |
order | enum | desc | asc or desc. |
environment | enum | token scope | development, staging, or production. |
Paginated responses include next_cursor. A null value means the current page is the last one.
Route fields
| Field | Type | Required | Constraint |
|---|---|---|---|
name | string | Yes | 2–64 lowercase letters, digits, and hyphens. |
service_id | string | Yes | Existing service in the same environment. |
timeout_ms | integer | No | 100–30,000; default 5,000. |
retry_count | integer | No | 0–2; retries only safe methods by default. |
strip_prefix | boolean | No | Default true. |
allowed_methods | array | No | Defaults to all standard HTTP methods. |
Platform limits
| Limit | Developer | Team | Scale |
|---|---|---|---|
| Request body | 2 MB | 10 MB | 25 MB |
| Response body | 5 MB | 25 MB | 100 MB |
| Gateway timeout | 10 s | 30 s | 60 s |
| Routes per workspace | 10 | 100 | Custom |
| Sustained requests | 10 req/s | 250 req/s | Custom |
| Burst window | 20 requests | 500 requests | Custom |
Rate-limit responses include Retry-After and reset headers. Contact support before a planned load test above 5,000 requests per second.