wayfarer/documentation/dsls/DSL:-Wayfarer.md
James Harton 4ad256acdd
All checks were successful
continuous-integration/drone/push Build is passing
feat: Add support for proxying websockets.
2024-08-17 18:50:43 +12:00

1240 lines
60 KiB
Markdown

<!--
This file was generated by Spark. Do not edit it by hand.
-->
# DSL: Wayfarer.Dsl
The Wayfarer DSL for defining static proxy configurations.
## DSL options
## wayfarer
* [config](#module-config)
* health_checks
* check
* host_patterns
* pattern
* listeners
* http
* https
* targets
* http
* health_checks
* check
* https
* health_checks
* check
* plug
* ws
* health_checks
* check
* wss
* health_checks
* check
---
### config
* health_checks
* check
* host_patterns
* pattern
* listeners
* http
* https
* targets
* http
* health_checks
* check
* https
* health_checks
* check
* plug
* ws
* health_checks
* check
* wss
* health_checks
* check
* `:name` (`t:String.t/0`) -
##### 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]`.
##### host_patterns
* pattern
###### pattern
* `:pattern` (`t:String.t/0`) - Required. A hostname matching pattern.
##### listeners
* http
* https
###### http
* `:scheme` - Required. The listening protocol. Valid values are :http, :https
* `:address` - Required. The address of the interface to listen on.
* `:name` - A unique name for the listener (defaults to the URI).
* `:port` (`t:pos_integer/0`) - Required. The TCP port on which to listen for incoming connections.
* `:http_1_options` (`t:keyword/0`) - Options to configure the HTTP/1 stack in Bandit. The default value is `[]`.
* `:http_2_options` (`t:keyword/0`) - Options to configure the HTTP/2 stack in Bandit. The default value is `[]`.
* `:thousand_island_options` (`t:keyword/0`) - Possible options to configure a ThousandIsland server. The default value is `[]`.
* `:websocket_options` (`t:keyword/0`) - Options to configure the WebSocket stack in Bandit. The default value is `[]`.
###### https
* `:scheme` - Required. The listening protocol. Valid values are :http, :https
* `:address` - Required. The address of the interface to listen on.
* `:name` - A unique name for the listener (defaults to the URI).
* `:port` (`t:pos_integer/0`) - Required. The TCP port on which to listen for incoming connections.
* `:http_1_options` (`t:keyword/0`) - Options to configure the HTTP/1 stack in Bandit. The default value is `[]`.
* `:http_2_options` (`t:keyword/0`) - Options to configure the HTTP/2 stack in Bandit. The default value is `[]`.
* `:thousand_island_options` (`t:keyword/0`) - Possible options to configure a ThousandIsland server. The default value is `[]`.
* `:websocket_options` (`t:keyword/0`) - Options to configure the WebSocket stack in Bandit. The default value is `[]`.
* `:certfile` (`t:String.t/0`) - The path to a file containing the SSL certificate to use for this listener.
* `:keyfile` (`t:String.t/0`) - The path to a file containing the SSL key to use for this listener.
* `:cipher_suite` - Used to define a pre-selected set of ciphers, as described by `Plug.SSL.configure/1`. Valid values are nil, :strong, :compatible
##### targets
* http
* health_checks
* check
* https
* health_checks
* check
* plug
* ws
* health_checks
* check
* wss
* health_checks
* check
* `:algorithm` - The target selection algorithm. Valid values are :round_robin, :sticky The default value is `:round_robin`.
###### http
* 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]`.
###### https
* 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]`.
###### plug
* `:module` (module that adopts `Plug` or a module and options) - Required. A plug which can handle requests.
###### ws
* 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]`.
###### 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]`.
## wayfarer
### Nested DSLs
* [config](#wayfarer-config)
* health_checks
* check
* host_patterns
* pattern
* listeners
* http
* https
* targets
* http
* health_checks
* check
* https
* health_checks
* check
* plug
* ws
* health_checks
* check
* wss
* health_checks
* check
## wayfarer.config
```elixir
config name \\ nil
```
### Nested DSLs
* [health_checks](#wayfarer-config-health_checks)
* check
* [host_patterns](#wayfarer-config-host_patterns)
* pattern
* [listeners](#wayfarer-config-listeners)
* http
* https
* [targets](#wayfarer-config-targets)
* http
* health_checks
* check
* https
* health_checks
* check
* plug
* ws
* health_checks
* check
* wss
* health_checks
* check
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`name`](#wayfarer-config-name){: #wayfarer-config-name } | `String.t` | | |
## wayfarer.config.health_checks
### Nested DSLs
* [check](#wayfarer-config-health_checks-check)
## wayfarer.config.health_checks.check
```elixir
check name \\ nil
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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. |
| [`connect_timeout`](#wayfarer-config-health_checks-check-connect_timeout){: #wayfarer-config-health_checks-check-connect_timeout } | `pos_integer` | `5000` | Connection timeout in milliseconds |
| [`response_timeout`](#wayfarer-config-health_checks-check-response_timeout){: #wayfarer-config-health_checks-check-response_timeout } | `pos_integer` | `500` | Response timeout in milliseconds |
| [`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. |
| [`interval`](#wayfarer-config-health_checks-check-interval){: #wayfarer-config-health_checks-check-interval } | `pos_integer` | `30000` | Interval in milliseconds |
| [`threshold`](#wayfarer-config-health_checks-check-threshold){: #wayfarer-config-health_checks-check-threshold } | `pos_integer` | `3` | Success threshold |
| [`path`](#wayfarer-config-health_checks-check-path){: #wayfarer-config-health_checks-check-path } | `String.t` | `"/"` | Path |
| [`success_codes`](#wayfarer-config-health_checks-check-success_codes){: #wayfarer-config-health_checks-check-success_codes } | `Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500 \| list(Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500)` | `[200..299]` | HTTP status codes which are considered successful. |
### Introspection
Target: `Wayfarer.Dsl.HealthCheck`
### Introspection
Target: `Wayfarer.Dsl.HealthChecks`
## wayfarer.config.host_patterns
### Nested DSLs
* [pattern](#wayfarer-config-host_patterns-pattern)
## wayfarer.config.host_patterns.pattern
```elixir
pattern pattern
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`pattern`](#wayfarer-config-host_patterns-pattern-pattern){: #wayfarer-config-host_patterns-pattern-pattern .spark-required} | `String.t` | | A hostname matching pattern. |
### Introspection
Target: `Wayfarer.Dsl.HostPattern`
### Introspection
Target: `Wayfarer.Dsl.HostPatterns`
## wayfarer.config.listeners
### Nested DSLs
* [http](#wayfarer-config-listeners-http)
* [https](#wayfarer-config-listeners-https)
## wayfarer.config.listeners.http
```elixir
http address, port
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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`. |
### Introspection
Target: `Wayfarer.Dsl.Listener`
### Introspection
Target: `Wayfarer.Dsl.Listeners`
## wayfarer.config.targets
### Nested DSLs
* [http](#wayfarer-config-targets-http)
* health_checks
* check
* [https](#wayfarer-config-targets-https)
* health_checks
* check
* [plug](#wayfarer-config-targets-plug)
* [ws](#wayfarer-config-targets-ws)
* health_checks
* check
* [wss](#wayfarer-config-targets-wss)
* health_checks
* check
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`algorithm`](#wayfarer-config-targets-algorithm){: #wayfarer-config-targets-algorithm } | `:round_robin \| :sticky` | `:round_robin` | The target selection algorithm. |
## wayfarer.config.targets.http
```elixir
http address, port
```
### Nested DSLs
* [health_checks](#wayfarer-config-targets-http-health_checks)
* check
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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). |
| [`transport`](#wayfarer-config-targets-http-transport){: #wayfarer-config-targets-http-transport } | `:http1 \| :http2 \| :auto` | `:auto` | Which HTTP protocol to use. |
## wayfarer.config.targets.http.health_checks
### Nested DSLs
* [check](#wayfarer-config-targets-http-health_checks-check)
## wayfarer.config.targets.http.health_checks.check
```elixir
check name \\ nil
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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. |
| [`connect_timeout`](#wayfarer-config-targets-http-health_checks-check-connect_timeout){: #wayfarer-config-targets-http-health_checks-check-connect_timeout } | `pos_integer` | `5000` | Connection timeout in milliseconds |
| [`response_timeout`](#wayfarer-config-targets-http-health_checks-check-response_timeout){: #wayfarer-config-targets-http-health_checks-check-response_timeout } | `pos_integer` | `500` | Response timeout in milliseconds |
| [`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. |
| [`interval`](#wayfarer-config-targets-http-health_checks-check-interval){: #wayfarer-config-targets-http-health_checks-check-interval } | `pos_integer` | `30000` | Interval in milliseconds |
| [`threshold`](#wayfarer-config-targets-http-health_checks-check-threshold){: #wayfarer-config-targets-http-health_checks-check-threshold } | `pos_integer` | `3` | Success threshold |
| [`path`](#wayfarer-config-targets-http-health_checks-check-path){: #wayfarer-config-targets-http-health_checks-check-path } | `String.t` | `"/"` | Path |
| [`success_codes`](#wayfarer-config-targets-http-health_checks-check-success_codes){: #wayfarer-config-targets-http-health_checks-check-success_codes } | `Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500 \| list(Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500)` | `[200..299]` | HTTP status codes which are considered successful. |
### Introspection
Target: `Wayfarer.Dsl.HealthCheck`
### Introspection
Target: `Wayfarer.Dsl.HealthChecks`
### Introspection
Target: `Wayfarer.Dsl.Target`
## wayfarer.config.targets.https
```elixir
https address, port
```
### Nested DSLs
* [health_checks](#wayfarer-config-targets-https-health_checks)
* check
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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). |
| [`transport`](#wayfarer-config-targets-https-transport){: #wayfarer-config-targets-https-transport } | `:http1 \| :http2 \| :auto` | `:auto` | Which HTTP protocol to use. |
## wayfarer.config.targets.https.health_checks
### Nested DSLs
* [check](#wayfarer-config-targets-https-health_checks-check)
## wayfarer.config.targets.https.health_checks.check
```elixir
check name \\ nil
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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. |
| [`connect_timeout`](#wayfarer-config-targets-https-health_checks-check-connect_timeout){: #wayfarer-config-targets-https-health_checks-check-connect_timeout } | `pos_integer` | `5000` | Connection timeout in milliseconds |
| [`response_timeout`](#wayfarer-config-targets-https-health_checks-check-response_timeout){: #wayfarer-config-targets-https-health_checks-check-response_timeout } | `pos_integer` | `500` | Response timeout in milliseconds |
| [`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. |
| [`interval`](#wayfarer-config-targets-https-health_checks-check-interval){: #wayfarer-config-targets-https-health_checks-check-interval } | `pos_integer` | `30000` | Interval in milliseconds |
| [`threshold`](#wayfarer-config-targets-https-health_checks-check-threshold){: #wayfarer-config-targets-https-health_checks-check-threshold } | `pos_integer` | `3` | Success threshold |
| [`path`](#wayfarer-config-targets-https-health_checks-check-path){: #wayfarer-config-targets-https-health_checks-check-path } | `String.t` | `"/"` | Path |
| [`success_codes`](#wayfarer-config-targets-https-health_checks-check-success_codes){: #wayfarer-config-targets-https-health_checks-check-success_codes } | `Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500 \| list(Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500)` | `[200..299]` | HTTP status codes which are considered successful. |
### Introspection
Target: `Wayfarer.Dsl.HealthCheck`
### Introspection
Target: `Wayfarer.Dsl.HealthChecks`
### Introspection
Target: `Wayfarer.Dsl.Target`
## wayfarer.config.targets.plug
```elixir
plug module
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`module`](#wayfarer-config-targets-plug-module){: #wayfarer-config-targets-plug-module .spark-required} | `module` | | A plug which can handle requests. |
### Introspection
Target: `Wayfarer.Dsl.Target`
## wayfarer.config.targets.ws
```elixir
ws address, port
```
### Nested DSLs
* [health_checks](#wayfarer-config-targets-ws-health_checks)
* check
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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. |
## wayfarer.config.targets.ws.health_checks
### Nested DSLs
* [check](#wayfarer-config-targets-ws-health_checks-check)
## wayfarer.config.targets.ws.health_checks.check
```elixir
check name \\ nil
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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. |
| [`connect_timeout`](#wayfarer-config-targets-ws-health_checks-check-connect_timeout){: #wayfarer-config-targets-ws-health_checks-check-connect_timeout } | `pos_integer` | `5000` | Connection timeout in milliseconds |
| [`response_timeout`](#wayfarer-config-targets-ws-health_checks-check-response_timeout){: #wayfarer-config-targets-ws-health_checks-check-response_timeout } | `pos_integer` | `500` | Response timeout in milliseconds |
| [`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. |
| [`interval`](#wayfarer-config-targets-ws-health_checks-check-interval){: #wayfarer-config-targets-ws-health_checks-check-interval } | `pos_integer` | `30000` | Interval in milliseconds |
| [`threshold`](#wayfarer-config-targets-ws-health_checks-check-threshold){: #wayfarer-config-targets-ws-health_checks-check-threshold } | `pos_integer` | `3` | Success threshold |
| [`path`](#wayfarer-config-targets-ws-health_checks-check-path){: #wayfarer-config-targets-ws-health_checks-check-path } | `String.t` | `"/"` | Path |
| [`success_codes`](#wayfarer-config-targets-ws-health_checks-check-success_codes){: #wayfarer-config-targets-ws-health_checks-check-success_codes } | `Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500 \| list(Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500)` | `[200..299]` | HTTP status codes which are considered successful. |
### Introspection
Target: `Wayfarer.Dsl.HealthCheck`
### Introspection
Target: `Wayfarer.Dsl.HealthChecks`
### Introspection
Target: `Wayfarer.Dsl.Target`
## wayfarer.config.targets.wss
```elixir
wss address, port
```
### Nested DSLs
* [health_checks](#wayfarer-config-targets-wss-health_checks)
* check
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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. |
## wayfarer.config.targets.wss.health_checks
### Nested DSLs
* [check](#wayfarer-config-targets-wss-health_checks-check)
## wayfarer.config.targets.wss.health_checks.check
```elixir
check name \\ nil
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`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. |
| [`connect_timeout`](#wayfarer-config-targets-wss-health_checks-check-connect_timeout){: #wayfarer-config-targets-wss-health_checks-check-connect_timeout } | `pos_integer` | `5000` | Connection timeout in milliseconds |
| [`response_timeout`](#wayfarer-config-targets-wss-health_checks-check-response_timeout){: #wayfarer-config-targets-wss-health_checks-check-response_timeout } | `pos_integer` | `500` | Response timeout in milliseconds |
| [`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. |
| [`interval`](#wayfarer-config-targets-wss-health_checks-check-interval){: #wayfarer-config-targets-wss-health_checks-check-interval } | `pos_integer` | `30000` | Interval in milliseconds |
| [`threshold`](#wayfarer-config-targets-wss-health_checks-check-threshold){: #wayfarer-config-targets-wss-health_checks-check-threshold } | `pos_integer` | `3` | Success threshold |
| [`path`](#wayfarer-config-targets-wss-health_checks-check-path){: #wayfarer-config-targets-wss-health_checks-check-path } | `String.t` | `"/"` | Path |
| [`success_codes`](#wayfarer-config-targets-wss-health_checks-check-success_codes){: #wayfarer-config-targets-wss-health_checks-check-success_codes } | `Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500 \| list(Range \| 100 \| 101 \| 102 \| 103 \| 104 \| 105 \| 106 \| 107 \| 108 \| 109 \| 110 \| 111 \| 112 \| 113 \| 114 \| 115 \| 116 \| 117 \| 118 \| 119 \| 120 \| 121 \| 122 \| 123 \| 124 \| 125 \| 126 \| 127 \| 128 \| 129 \| 130 \| 131 \| 132 \| 133 \| 134 \| 135 \| 136 \| 137 \| 138 \| 139 \| 140 \| 141 \| 142 \| 143 \| 144 \| 145 \| 146 \| 147 \| 148 \| 149 \| 150 \| 151 \| 152 \| 153 \| 154 \| 155 \| 156 \| 157 \| 158 \| 159 \| 160 \| 161 \| 162 \| 163 \| 164 \| 165 \| 166 \| 167 \| 168 \| 169 \| 170 \| 171 \| 172 \| 173 \| 174 \| 175 \| 176 \| 177 \| 178 \| 179 \| 180 \| 181 \| 182 \| 183 \| 184 \| 185 \| 186 \| 187 \| 188 \| 189 \| 190 \| 191 \| 192 \| 193 \| 194 \| 195 \| 196 \| 197 \| 198 \| 199 \| 200 \| 201 \| 202 \| 203 \| 204 \| 205 \| 206 \| 207 \| 208 \| 209 \| 210 \| 211 \| 212 \| 213 \| 214 \| 215 \| 216 \| 217 \| 218 \| 219 \| 220 \| 221 \| 222 \| 223 \| 224 \| 225 \| 226 \| 227 \| 228 \| 229 \| 230 \| 231 \| 232 \| 233 \| 234 \| 235 \| 236 \| 237 \| 238 \| 239 \| 240 \| 241 \| 242 \| 243 \| 244 \| 245 \| 246 \| 247 \| 248 \| 249 \| 250 \| 251 \| 252 \| 253 \| 254 \| 255 \| 256 \| 257 \| 258 \| 259 \| 260 \| 261 \| 262 \| 263 \| 264 \| 265 \| 266 \| 267 \| 268 \| 269 \| 270 \| 271 \| 272 \| 273 \| 274 \| 275 \| 276 \| 277 \| 278 \| 279 \| 280 \| 281 \| 282 \| 283 \| 284 \| 285 \| 286 \| 287 \| 288 \| 289 \| 290 \| 291 \| 292 \| 293 \| 294 \| 295 \| 296 \| 297 \| 298 \| 299 \| 300 \| 301 \| 302 \| 303 \| 304 \| 305 \| 306 \| 307 \| 308 \| 309 \| 310 \| 311 \| 312 \| 313 \| 314 \| 315 \| 316 \| 317 \| 318 \| 319 \| 320 \| 321 \| 322 \| 323 \| 324 \| 325 \| 326 \| 327 \| 328 \| 329 \| 330 \| 331 \| 332 \| 333 \| 334 \| 335 \| 336 \| 337 \| 338 \| 339 \| 340 \| 341 \| 342 \| 343 \| 344 \| 345 \| 346 \| 347 \| 348 \| 349 \| 350 \| 351 \| 352 \| 353 \| 354 \| 355 \| 356 \| 357 \| 358 \| 359 \| 360 \| 361 \| 362 \| 363 \| 364 \| 365 \| 366 \| 367 \| 368 \| 369 \| 370 \| 371 \| 372 \| 373 \| 374 \| 375 \| 376 \| 377 \| 378 \| 379 \| 380 \| 381 \| 382 \| 383 \| 384 \| 385 \| 386 \| 387 \| 388 \| 389 \| 390 \| 391 \| 392 \| 393 \| 394 \| 395 \| 396 \| 397 \| 398 \| 399 \| 400 \| 401 \| 402 \| 403 \| 404 \| 405 \| 406 \| 407 \| 408 \| 409 \| 410 \| 411 \| 412 \| 413 \| 414 \| 415 \| 416 \| 417 \| 418 \| 419 \| 420 \| 421 \| 422 \| 423 \| 424 \| 425 \| 426 \| 427 \| 428 \| 429 \| 430 \| 431 \| 432 \| 433 \| 434 \| 435 \| 436 \| 437 \| 438 \| 439 \| 440 \| 441 \| 442 \| 443 \| 444 \| 445 \| 446 \| 447 \| 448 \| 449 \| 450 \| 451 \| 452 \| 453 \| 454 \| 455 \| 456 \| 457 \| 458 \| 459 \| 460 \| 461 \| 462 \| 463 \| 464 \| 465 \| 466 \| 467 \| 468 \| 469 \| 470 \| 471 \| 472 \| 473 \| 474 \| 475 \| 476 \| 477 \| 478 \| 479 \| 480 \| 481 \| 482 \| 483 \| 484 \| 485 \| 486 \| 487 \| 488 \| 489 \| 490 \| 491 \| 492 \| 493 \| 494 \| 495 \| 496 \| 497 \| 498 \| 499 \| 500)` | `[200..299]` | HTTP status codes which are considered successful. |
### Introspection
Target: `Wayfarer.Dsl.HealthCheck`
### Introspection
Target: `Wayfarer.Dsl.HealthChecks`
### Introspection
Target: `Wayfarer.Dsl.Target`
### Introspection
Target: `Wayfarer.Dsl.Targets`
### Introspection
Target: `Wayfarer.Dsl.Config`
<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>