*`:method` - The HTTP method to use for the request. Valid values are :get, :head, :post, :put, :delete, :connect, :options, :trace, :patch The default value is `:get`.
*`:connect_timeout` (`t:pos_integer/0`) - Connection timeout in milliseconds The default value is `5000`.
*`:response_timeout` (`t:pos_integer/0`) - Response timeout in milliseconds The default value is `500`.
*`:hostname` - The HTTP hostname to use when sending the request. Defaults to the IP address.
*`:interval` (`t:pos_integer/0`) - Interval in milliseconds The default value is `30000`.
*`:threshold` (`t:pos_integer/0`) - Success threshold The default value is `3`.
*`:path` (`t:String.t/0`) - Path The default value is `"/"`.
*`:method` - The HTTP method to use for the request. Valid values are :get, :head, :post, :put, :delete, :connect, :options, :trace, :patch The default value is `:get`.
*`:connect_timeout` (`t:pos_integer/0`) - Connection timeout in milliseconds The default value is `5000`.
*`:response_timeout` (`t:pos_integer/0`) - Response timeout in milliseconds The default value is `500`.
*`:hostname` - The HTTP hostname to use when sending the request. Defaults to the IP address.
*`:interval` (`t:pos_integer/0`) - Interval in milliseconds The default value is `30000`.
*`:threshold` (`t:pos_integer/0`) - Success threshold The default value is `3`.
*`:path` (`t:String.t/0`) - Path The default value is `"/"`.
*`:method` - The HTTP method to use for the request. Valid values are :get, :head, :post, :put, :delete, :connect, :options, :trace, :patch The default value is `:get`.
*`:connect_timeout` (`t:pos_integer/0`) - Connection timeout in milliseconds The default value is `5000`.
*`:response_timeout` (`t:pos_integer/0`) - Response timeout in milliseconds The default value is `500`.
*`:hostname` - The HTTP hostname to use when sending the request. Defaults to the IP address.
*`:interval` (`t:pos_integer/0`) - Interval in milliseconds The default value is `30000`.
*`:threshold` (`t:pos_integer/0`) - Success threshold The default value is `3`.
*`:path` (`t:String.t/0`) - Path The default value is `"/"`.
*`:address` - Required. The address of the interface to listen on.
*`:name` - A unique name for the target (defaults to the URI).
*`:port` (`t:pos_integer/0`) - Required. The TCP port on which to listen for incoming connections.
*`:transport` - Which HTTP protocol to use. Valid values are :http1, :http2, :auto The default value is `:auto`.
####### health_checks
* check
######## check
*`:name` - A unique name for the health check.
*`:method` - The HTTP method to use for the request. Valid values are :get, :head, :post, :put, :delete, :connect, :options, :trace, :patch The default value is `:get`.
*`:connect_timeout` (`t:pos_integer/0`) - Connection timeout in milliseconds The default value is `5000`.
*`:response_timeout` (`t:pos_integer/0`) - Response timeout in milliseconds The default value is `500`.
*`:hostname` - The HTTP hostname to use when sending the request. Defaults to the IP address.
*`:interval` (`t:pos_integer/0`) - Interval in milliseconds The default value is `30000`.
*`:threshold` (`t:pos_integer/0`) - Success threshold The default value is `3`.
*`:path` (`t:String.t/0`) - Path The default value is `"/"`.
*`:success_codes` - HTTP status codes which are considered successful. The default value is `[200..299]`.
###### wss
* health_checks
* check
*`:address` - Required. The address of the interface to listen on.
*`:name` - A unique name for the target (defaults to the URI).
*`:port` (`t:pos_integer/0`) - Required. The TCP port on which to listen for incoming connections.
*`:transport` - Which HTTP protocol to use. Valid values are :http1, :http2, :auto The default value is `:auto`.
####### health_checks
* check
######## check
*`:name` - A unique name for the health check.
*`:method` - The HTTP method to use for the request. Valid values are :get, :head, :post, :put, :delete, :connect, :options, :trace, :patch The default value is `:get`.
*`:connect_timeout` (`t:pos_integer/0`) - Connection timeout in milliseconds The default value is `5000`.
*`:response_timeout` (`t:pos_integer/0`) - Response timeout in milliseconds The default value is `500`.
*`:hostname` - The HTTP hostname to use when sending the request. Defaults to the IP address.
*`:interval` (`t:pos_integer/0`) - Interval in milliseconds The default value is `30000`.
*`:threshold` (`t:pos_integer/0`) - Success threshold The default value is `3`.
*`:path` (`t:String.t/0`) - Path The default value is `"/"`.
*`:success_codes` - HTTP status codes which are considered successful. The default value is `[200..299]`.
| [`name`](#wayfarer-config-health_checks-check-name){: #wayfarer-config-health_checks-check-name } | `String.t \| nil` | | A unique name for the health check. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`method`](#wayfarer-config-health_checks-check-method){: #wayfarer-config-health_checks-check-method } | `:get \| :head \| :post \| :put \| :delete \| :connect \| :options \| :trace \| :patch` | `:get` | The HTTP method to use for the request. |
| [`hostname`](#wayfarer-config-health_checks-check-hostname){: #wayfarer-config-health_checks-check-hostname } | `nil \| String.t` | | The HTTP hostname to use when sending the request. Defaults to the IP address. |
| [`address`](#wayfarer-config-listeners-http-address){: #wayfarer-config-listeners-http-address .spark-required} | `IP.Address \| String.t` | | The address of the interface to listen on. |
| [`port`](#wayfarer-config-listeners-http-port){: #wayfarer-config-listeners-http-port .spark-required} | `pos_integer` | | The TCP port on which to listen for incoming connections. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`name`](#wayfarer-config-listeners-http-name){: #wayfarer-config-listeners-http-name } | `nil \| String.t` | | A unique name for the listener (defaults to the URI). |
| [`http_1_options`](#wayfarer-config-listeners-http-http_1_options){: #wayfarer-config-listeners-http-http_1_options } | `keyword` | `[]` | Options to configure the HTTP/1 stack in Bandit. |
| [`http_2_options`](#wayfarer-config-listeners-http-http_2_options){: #wayfarer-config-listeners-http-http_2_options } | `keyword` | `[]` | Options to configure the HTTP/2 stack in Bandit. |
| [`thousand_island_options`](#wayfarer-config-listeners-http-thousand_island_options){: #wayfarer-config-listeners-http-thousand_island_options } | `keyword` | `[]` | Possible options to configure a ThousandIsland server. |
| [`websocket_options`](#wayfarer-config-listeners-http-websocket_options){: #wayfarer-config-listeners-http-websocket_options } | `keyword` | `[]` | Options to configure the WebSocket stack in Bandit. |
### Introspection
Target: `Wayfarer.Dsl.Listener`
## wayfarer.config.listeners.https
```elixir
https address, port
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`address`](#wayfarer-config-listeners-https-address){: #wayfarer-config-listeners-https-address .spark-required} | `IP.Address \| String.t` | | The address of the interface to listen on. |
| [`port`](#wayfarer-config-listeners-https-port){: #wayfarer-config-listeners-https-port .spark-required} | `pos_integer` | | The TCP port on which to listen for incoming connections. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`name`](#wayfarer-config-listeners-https-name){: #wayfarer-config-listeners-https-name } | `nil \| String.t` | | A unique name for the listener (defaults to the URI). |
| [`http_1_options`](#wayfarer-config-listeners-https-http_1_options){: #wayfarer-config-listeners-https-http_1_options } | `keyword` | `[]` | Options to configure the HTTP/1 stack in Bandit. |
| [`http_2_options`](#wayfarer-config-listeners-https-http_2_options){: #wayfarer-config-listeners-https-http_2_options } | `keyword` | `[]` | Options to configure the HTTP/2 stack in Bandit. |
| [`thousand_island_options`](#wayfarer-config-listeners-https-thousand_island_options){: #wayfarer-config-listeners-https-thousand_island_options } | `keyword` | `[]` | Possible options to configure a ThousandIsland server. |
| [`websocket_options`](#wayfarer-config-listeners-https-websocket_options){: #wayfarer-config-listeners-https-websocket_options } | `keyword` | `[]` | Options to configure the WebSocket stack in Bandit. |
| [`certfile`](#wayfarer-config-listeners-https-certfile){: #wayfarer-config-listeners-https-certfile } | `String.t` | | The path to a file containing the SSL certificate to use for this listener. |
| [`keyfile`](#wayfarer-config-listeners-https-keyfile){: #wayfarer-config-listeners-https-keyfile } | `String.t` | | The path to a file containing the SSL key to use for this listener. |
| [`cipher_suite`](#wayfarer-config-listeners-https-cipher_suite){: #wayfarer-config-listeners-https-cipher_suite } | `nil \| :strong \| :compatible` | | Used to define a pre-selected set of ciphers, as described by `Plug.SSL.configure/1`. |
| [`address`](#wayfarer-config-targets-http-address){: #wayfarer-config-targets-http-address .spark-required} | `IP.Address \| String.t` | | The address of the interface to listen on. |
| [`port`](#wayfarer-config-targets-http-port){: #wayfarer-config-targets-http-port .spark-required} | `pos_integer` | | The TCP port on which to listen for incoming connections. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`name`](#wayfarer-config-targets-http-name){: #wayfarer-config-targets-http-name } | `nil \| String.t` | | A unique name for the target (defaults to the URI). |
| [`name`](#wayfarer-config-targets-http-health_checks-check-name){: #wayfarer-config-targets-http-health_checks-check-name } | `String.t \| nil` | | A unique name for the health check. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`method`](#wayfarer-config-targets-http-health_checks-check-method){: #wayfarer-config-targets-http-health_checks-check-method } | `:get \| :head \| :post \| :put \| :delete \| :connect \| :options \| :trace \| :patch` | `:get` | The HTTP method to use for the request. |
| [`hostname`](#wayfarer-config-targets-http-health_checks-check-hostname){: #wayfarer-config-targets-http-health_checks-check-hostname } | `nil \| String.t` | | The HTTP hostname to use when sending the request. Defaults to the IP address. |
| [`address`](#wayfarer-config-targets-https-address){: #wayfarer-config-targets-https-address .spark-required} | `IP.Address \| String.t` | | The address of the interface to listen on. |
| [`port`](#wayfarer-config-targets-https-port){: #wayfarer-config-targets-https-port .spark-required} | `pos_integer` | | The TCP port on which to listen for incoming connections. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`name`](#wayfarer-config-targets-https-name){: #wayfarer-config-targets-https-name } | `nil \| String.t` | | A unique name for the target (defaults to the URI). |
| [`name`](#wayfarer-config-targets-https-health_checks-check-name){: #wayfarer-config-targets-https-health_checks-check-name } | `String.t \| nil` | | A unique name for the health check. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`method`](#wayfarer-config-targets-https-health_checks-check-method){: #wayfarer-config-targets-https-health_checks-check-method } | `:get \| :head \| :post \| :put \| :delete \| :connect \| :options \| :trace \| :patch` | `:get` | The HTTP method to use for the request. |
| [`hostname`](#wayfarer-config-targets-https-health_checks-check-hostname){: #wayfarer-config-targets-https-health_checks-check-hostname } | `nil \| String.t` | | The HTTP hostname to use when sending the request. Defaults to the IP address. |
| [`module`](#wayfarer-config-targets-plug-module){: #wayfarer-config-targets-plug-module .spark-required} | `module` | | A plug which can handle requests. |
| [`address`](#wayfarer-config-targets-ws-address){: #wayfarer-config-targets-ws-address .spark-required} | `IP.Address \| String.t` | | The address of the interface to listen on. |
| [`port`](#wayfarer-config-targets-ws-port){: #wayfarer-config-targets-ws-port .spark-required} | `pos_integer` | | The TCP port on which to listen for incoming connections. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`name`](#wayfarer-config-targets-ws-name){: #wayfarer-config-targets-ws-name } | `nil \| String.t` | | A unique name for the target (defaults to the URI). |
| [`transport`](#wayfarer-config-targets-ws-transport){: #wayfarer-config-targets-ws-transport } | `:http1 \| :http2 \| :auto` | `:auto` | Which HTTP protocol to use. |
| [`name`](#wayfarer-config-targets-ws-health_checks-check-name){: #wayfarer-config-targets-ws-health_checks-check-name } | `String.t \| nil` | | A unique name for the health check. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`method`](#wayfarer-config-targets-ws-health_checks-check-method){: #wayfarer-config-targets-ws-health_checks-check-method } | `:get \| :head \| :post \| :put \| :delete \| :connect \| :options \| :trace \| :patch` | `:get` | The HTTP method to use for the request. |
| [`hostname`](#wayfarer-config-targets-ws-health_checks-check-hostname){: #wayfarer-config-targets-ws-health_checks-check-hostname } | `nil \| String.t` | | The HTTP hostname to use when sending the request. Defaults to the IP address. |
| [`address`](#wayfarer-config-targets-wss-address){: #wayfarer-config-targets-wss-address .spark-required} | `IP.Address \| String.t` | | The address of the interface to listen on. |
| [`port`](#wayfarer-config-targets-wss-port){: #wayfarer-config-targets-wss-port .spark-required} | `pos_integer` | | The TCP port on which to listen for incoming connections. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`name`](#wayfarer-config-targets-wss-name){: #wayfarer-config-targets-wss-name } | `nil \| String.t` | | A unique name for the target (defaults to the URI). |
| [`transport`](#wayfarer-config-targets-wss-transport){: #wayfarer-config-targets-wss-transport } | `:http1 \| :http2 \| :auto` | `:auto` | Which HTTP protocol to use. |
| [`name`](#wayfarer-config-targets-wss-health_checks-check-name){: #wayfarer-config-targets-wss-health_checks-check-name } | `String.t \| nil` | | A unique name for the health check. |
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`method`](#wayfarer-config-targets-wss-health_checks-check-method){: #wayfarer-config-targets-wss-health_checks-check-method } | `:get \| :head \| :post \| :put \| :delete \| :connect \| :options \| :trace \| :patch` | `:get` | The HTTP method to use for the request. |
| [`hostname`](#wayfarer-config-targets-wss-health_checks-check-hostname){: #wayfarer-config-targets-wss-health_checks-check-hostname } | `nil \| String.t` | | The HTTP hostname to use when sending the request. Defaults to the IP address. |