Reference
Reference: runtime type proxy
tenants[].applications[].routes[].runtime<proxy>.backends
| Syntax | backends: [{...}, ...] |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: proxy) |
| Reload | applies on reload |
Weighted split per request across pools (alternative to upstream).
tenants[].applications[].routes[].runtime<proxy>.backends[].pool
| Syntax | pool: <string> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime<proxy>.backends[] |
| Reload | applies on reload |
Name of a pool in upstreams; alternative to status.
tenants[].applications[].routes[].runtime<proxy>.backends[].status
| Syntax | status: <integer> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime<proxy>.backends[] |
| Reload | applies on reload |
Answers this share of the requests with this status (500-599) instead of sending them to a pool.
tenants[].applications[].routes[].runtime<proxy>.backends[].weight
| Syntax | weight: <integer> |
| Default | 1 |
| Context | tenants[].applications[].routes[].runtime<proxy>.backends[] |
| Reload | applies on reload |
Share of requests (0..=1000); 0 sends none.
tenants[].applications[].routes[].runtime<proxy>.client
| Syntax | client: hyper | experimental |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: proxy) |
| Reload | applies on reload |
HTTP/1 client used towards this upstream; unset: server.upstream_client.
tenants[].applications[].routes[].runtime<proxy>.connect_timeout
| Syntax | connect_timeout: <duration> (e.g. 30s) |
| Default | 5s |
| Context | tenants[].applications[].routes[].runtime (type: proxy) |
| Reload | applies on reload |
Time to establish a connection to the upstream.
tenants[].applications[].routes[].runtime<proxy>.preserve_host
| Syntax | preserve_host: true | false |
| Default | true |
| Context | tenants[].applications[].routes[].runtime (type: proxy) |
| Reload | applies on reload |
Forward the client’s Host header (default) instead of the upstream authority.
tenants[].applications[].routes[].runtime<proxy>.response_timeout
| Syntax | response_timeout: <duration> (e.g. 30s) |
| Default | 60s |
| Context | tenants[].applications[].routes[].runtime (type: proxy) |
| Reload | applies on reload |
Time allowed for the upstream to return response headers.
tenants[].applications[].routes[].runtime<proxy>.tls_ca_file
| Syntax | tls_ca_file: <string> |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: proxy) |
| Reload | applies on reload |
Extra CA bundle (PEM) trusted for https:// upstreams, in addition to the system roots.
tenants[].applications[].routes[].runtime<proxy>.upstream
| Syntax | upstream: <string> | {...} |
| Default | none |
| Context | tenants[].applications[].routes[].runtime (type: proxy) |
| Reload | applies on reload |
http://host:port, https://host:port or unix:/absolute/path.sock (one address, no retries), or {pool: name}: a pool from upstreams.
tenants[].applications[].routes[].runtime<proxy>.upstream.pool
| Syntax | pool: <string> |
| Default | required |
| Context | tenants[].applications[].routes[].runtime<proxy>.upstream |
| Reload | applies on reload |
Name of a pool in upstreams.
tenants[].applications[].routes[].runtime<proxy>.websocket
| Syntax | websocket: true | false |
| Default | true |
| Context | tenants[].applications[].routes[].runtime (type: proxy) |
| Reload | applies on reload |
Allow WebSocket upgrades to be tunnelled to this upstream.
tenants[].applications[].runtime<proxy>.backends
| Syntax | backends: [{...}, ...] |
| Default | none |
| Context | tenants[].applications[].runtime (type: proxy) |
| Reload | applies on reload |
Weighted split per request across pools (alternative to upstream).
tenants[].applications[].runtime<proxy>.backends[].pool
| Syntax | pool: <string> |
| Default | none |
| Context | tenants[].applications[].runtime<proxy>.backends[] |
| Reload | applies on reload |
Name of a pool in upstreams; alternative to status.
tenants[].applications[].runtime<proxy>.backends[].status
| Syntax | status: <integer> |
| Default | none |
| Context | tenants[].applications[].runtime<proxy>.backends[] |
| Reload | applies on reload |
Answers this share of the requests with this status (500-599) instead of sending them to a pool.
tenants[].applications[].runtime<proxy>.backends[].weight
| Syntax | weight: <integer> |
| Default | 1 |
| Context | tenants[].applications[].runtime<proxy>.backends[] |
| Reload | applies on reload |
Share of requests (0..=1000); 0 sends none.
tenants[].applications[].runtime<proxy>.client
| Syntax | client: hyper | experimental |
| Default | none |
| Context | tenants[].applications[].runtime (type: proxy) |
| Reload | applies on reload |
HTTP/1 client used towards this upstream; unset: server.upstream_client.
tenants[].applications[].runtime<proxy>.connect_timeout
| Syntax | connect_timeout: <duration> (e.g. 30s) |
| Default | 5s |
| Context | tenants[].applications[].runtime (type: proxy) |
| Reload | applies on reload |
Time to establish a connection to the upstream.
tenants[].applications[].runtime<proxy>.preserve_host
| Syntax | preserve_host: true | false |
| Default | true |
| Context | tenants[].applications[].runtime (type: proxy) |
| Reload | applies on reload |
Forward the client’s Host header (default) instead of the upstream authority.
tenants[].applications[].runtime<proxy>.response_timeout
| Syntax | response_timeout: <duration> (e.g. 30s) |
| Default | 60s |
| Context | tenants[].applications[].runtime (type: proxy) |
| Reload | applies on reload |
Time allowed for the upstream to return response headers.
tenants[].applications[].runtime<proxy>.tls_ca_file
| Syntax | tls_ca_file: <string> |
| Default | none |
| Context | tenants[].applications[].runtime (type: proxy) |
| Reload | applies on reload |
Extra CA bundle (PEM) trusted for https:// upstreams, in addition to the system roots.
tenants[].applications[].runtime<proxy>.upstream
| Syntax | upstream: <string> | {...} |
| Default | none |
| Context | tenants[].applications[].runtime (type: proxy) |
| Reload | applies on reload |
http://host:port, https://host:port or unix:/absolute/path.sock (one address, no retries), or {pool: name}: a pool from upstreams.
tenants[].applications[].runtime<proxy>.upstream.pool
| Syntax | pool: <string> |
| Default | required |
| Context | tenants[].applications[].runtime<proxy>.upstream |
| Reload | applies on reload |
Name of a pool in upstreams.
tenants[].applications[].runtime<proxy>.websocket
| Syntax | websocket: true | false |
| Default | true |
| Context | tenants[].applications[].runtime (type: proxy) |
| Reload | applies on reload |
Allow WebSocket upgrades to be tunnelled to this upstream.