Validate route

Validate route,

Request Body

application/yaml

Route

TypeScript Definitions

Use the request body type in TypeScript.

access_log?

agent?string

alias?string

Alias is route lookup key.

Supported HTTP host-match forms:

short alias: "app"
FQDN alias: "app.example.com"
leading-label wildcard alias: "*.example.com"

Wildcard aliases match exactly one leftmost label and are checked only after normal exact/domain lookup misses, preserving the fast path for exact routes.

bind?string

container?

Docker only

disable_compression?boolean

excluded?boolean

excluded_reason?string

health?

for swagger

healthcheck?

null on load-balancer routes

homepage?

host?string

idlewatcher?

inbound_mtls_profile?string

HTTP-based routes only: must match a configured inbound_mtls_profiles entry and is ignored when entrypoint.inbound_mtls_profile is set

index?string

Index file to serve for single-page app mode

load_balance?

lurl?string

max_conns_per_host?integer

middlewares?

no_tls_verify?boolean

port?

provider?string

for backward compatibility

proxmox?

purl?string

relay_proxy_protocol_header?boolean

TCP only: relay PROXY protocol header to the destination

response_header_timeout?integer

root?string

rule_file?string

rules?array<>

scheme?string

Value in"http" | "https" | "h2c" | "tcp" | "udp" | "fileserver"

spa?boolean

Single-page app mode: serves index for non-existent paths

ssl_certificate?string

Path to client certificate

ssl_certificate_key?string

Path to client certificate key

ssl_protocols?array<string>

Allowed TLS protocols

ssl_server_name?string

SSL/TLS proxy options (nginx-like)

ssl_trusted_certificate?string

Path to trusted CA certificates

tls_termination?boolean

TCP only: terminate inbound TLS on the shared HTTPS listener before proxying plaintext to the destination

Response Body

`application/json`

curl -X POST "https://example.com/route/validate" \  -H "Content-Type: application/yaml" \  -d ''

{
  "details": {
    "property1": null,
    "property2": null
  },
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

null

{
  "error": "string",
  "message": "string"
}

Validate route

Request Body

Response Body

200application/json

400application/json

403application/json

417application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`