Reference

Reference: routes

tenants[].applications[].routes

Routes with their own runtime: prefix (default), exact or regex paths plus method, header and query matchers; see ADR-0050.

tenants[].applications[].routes[].allow

Client addresses and CIDR blocks allowed; if set, only these clients (403 else).

tenants[].applications[].routes[].basic_auth

HTTP basic authentication against an htpasswd file.

tenants[].applications[].routes[].basic_auth.realm

Realm shown by the browser (default Restricted).

tenants[].applications[].routes[].basic_auth.users_file

Absolute path of an htpasswd file (bcrypt, SHA-256/512 crypt or Apache MD5 entries).

tenants[].applications[].routes[].cors

Cross-origin resource sharing; preflight requests are answered by ScalWS.

tenants[].applications[].routes[].cors.allow_credentials

Allow credentials (cookies, authorization); not with allow_origins: ["*"].

tenants[].applications[].routes[].cors.allow_headers

Request headers allowed in preflight answers (ingress-nginx defaults).

tenants[].applications[].routes[].cors.allow_methods

Methods allowed in preflight answers (default: GET, PUT, POST, DELETE, PATCH, OPTIONS).

tenants[].applications[].routes[].cors.allow_origins

Allowed origins, e.g. https://app.example.com, https://*.example.com, or ["*"].

tenants[].applications[].routes[].cors.expose_headers

Response headers exposed to the page.

tenants[].applications[].routes[].cors.max_age

How long a preflight answer may be cached, at most 365 days (default 20 days).

tenants[].applications[].routes[].deny

Client addresses and CIDR blocks refused with 403; checked after allow.

tenants[].applications[].routes[].headers

Request headers that must match (all of them).

tenants[].applications[].routes[].headers[].name

Header name (case-insensitive) or query parameter name.

tenants[].applications[].routes[].headers[].regex

Regular expression the value must match (searched anywhere unless anchored).

tenants[].applications[].routes[].headers[].value

Exact, case-sensitive value.

tenants[].applications[].routes[].https_redirect

Answer plain-HTTP requests that select this route with a 301 to HTTPS; unset: the application’s https_redirect.

tenants[].applications[].routes[].max_body

Largest request body; overrides limits.max_request_body_bytes; 413 above.

tenants[].applications[].routes[].methods

Request methods this route matches, e.g. [GET, POST]; empty: any.

tenants[].applications[].routes[].path

Path of the route; how it is compared depends on path_type.

tenants[].applications[].routes[].path_type

prefix (default, whole segments, longest first), exact or regex (anchored at the start, in configuration order).

tenants[].applications[].routes[].query

Query parameters that must match (all of them, decoded, first occurrence).

tenants[].applications[].routes[].query[].name

Header name (case-insensitive) or query parameter name.

tenants[].applications[].routes[].query[].regex

Regular expression the value must match (searched anywhere unless anchored).

tenants[].applications[].routes[].query[].value

Exact, case-sensitive value.

tenants[].applications[].routes[].request_headers

Changes to the request headers (after the built-in proxy headers).

tenants[].applications[].routes[].request_headers.add

Headers added next to any present.

tenants[].applications[].routes[].request_headers.remove

Headers removed.

tenants[].applications[].routes[].request_headers.set

Headers set to this value, replacing any present.

tenants[].applications[].routes[].request_timeout

Time from the route match until the response head; 504 when exceeded.

tenants[].applications[].routes[].response_headers

Changes to every response of the route, including errors generated by ScalWS.

tenants[].applications[].routes[].response_headers.add

Headers added next to any present.

tenants[].applications[].routes[].response_headers.remove

Headers removed.

tenants[].applications[].routes[].response_headers.set

Headers set to this value, replacing any present.

tenants[].applications[].routes[].rewrite

Path and Host rewrite before the runtime.

tenants[].applications[].routes[].rewrite.host

Host sent upstream (implies preserve_host: false), host or host:port.

tenants[].applications[].routes[].rewrite.path

Full path; $1..$9 from a regex route, $0 the match, $$ a literal $; ?... in it sets the query (else the query is kept).

tenants[].applications[].routes[].rewrite.prefix

Replaces the matched prefix (prefix routes only).

tenants[].applications[].routes[].runtime

Runtime that handles requests under the path.