Configure application server routes
configure_application_server_routesReplace the complete hostname-to-local-port route set for a Managed Applications server after reading current routes; submit the full confirmed list and fallback to apply changes.
Instructions
Queue a change of the server routes of one owned Managed Applications server. This REPLACES the COMPLETE set: read get_application_server_routes first, then send the full list of wanted routes and the fallback; a route or fallback that is omitted is removed. Each route sends one customer hostname to 127.0.0.1: on the same server over http or https (ports 1024-65535 except 10080, 10443 and 19090; no host field, upstream is always local; at most 64 routes). The hostname needs verified ownership evidence as well as DNS pointing at the server; pointing DNS alone does not prove ownership. get_application_server_routes reports DNS, per-route state/errors and records to create. Preserve backend refusals, including applicationServerRoutesDeliveredCertificates when delivered certificates prevent enabling routes. Removed hostname claims are not released until the change is applied. The server must have at least one installed managed application. Unknown hostnames are never sent to an application (HTTP 421 / TLS unrecognized_name). Coexistence: if the customer runs their own web server (Caddy, nginx, Traefik) on ports 80/443, either point it at local ports instead, or move it to local ports and declare it as fallback ({http_port?, https_port?}); the fallback receives every hostname the front door does not serve (HTTP proxied with its Host header, HTTPS passed through unterminated). Pass expected_revision from the read; a stale revision is refused with applicationServerRoutesRevisionConflict. Confirm the exact full set with the user first. A queued response (202, action type configure_routes) must be verified by polling get_application_server_routes until state is active. Requires applications:manage and is not a paid API-key operation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| routes | Yes | The COMPLETE wanted set of routes; omitting a route removes it. An empty array removes all routes. | |
| orderNo | Yes | Tenant-owned service order number: 1-64 ASCII letters, digits or hyphens, e.g. VP12345 or VP12345-1 | |
| fallback | No | The customer's own web server on local ports, receiving every hostname the front door does not serve. null or omitted removes the fallback. | |
| confirmed | Yes | True only after the user confirmed the complete route set | |
| idempotencyKey | Yes | Client-global unique key. Reuse it only to replay this exact request; never reuse it for another service or request. | |
| expected_revision | Yes | Current revision returned by get_application_server_routes |