The API name. If none is specified, will default to the request_host or request_path.

A comma-separated list of domain names that point to your API. For example: example.com. At least one of hosts, uris, or methods should be specified.

A comma-separated list of URIs prefixes that point to your API. For example: /my-path. At least one of hosts, uris, or methods should be specified.

A comma-separated list of HTTP methods that point to your API. For example: GET,POST. At least one of hosts, uris, or methods should be specified.

The base target URL that points to your API server, this URL will be used for proxying requests. For example, https://mockbin.com.

When matching an API via one of the uris prefixes, strip that matching prefix from the upstream URI to be requested. Default: true.

When matching an API via one of the hosts domain names, make sure the request Host header is forwarded to the upstream service. By default, this is false, and the upstream Host header will be extracted from the configured upstream_url.

The number of retries to execute upon failure to proxy. The default is 5.

The timeout in milliseconds for establishing a connection to your upstream service. Defaults to 60000

The timeout in milliseconds between two successive write operations for transmitting a request to your upstream service. Defaults to 60000

The timeout in milliseconds between two successive read operations for transmitting a request to your upstream service. Defaults to 60000

To be enabled if you wish to only serve an API through HTTPS, on the appropriate port (8443 by default). Default: false.

Consider the X-Forwarded-Proto header when enforcing HTTPS only traffic. Default: true.