GoDoxy

Validate route

POST
/route/validate

Validate route,

Request Body

Route

application/yaml
  1. body
access_log?|null
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|null
container?|

Docker only

disable_compression?boolean
excluded?boolean|null
excluded_reason?string|null
health?

for swagger

healthcheck?|

null on load-balancer routes

homepage?
host?string
idlewatcher?|null
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?|null
lurl?string|null
max_conns_per_host?integer
middlewares?|null
no_tls_verify?boolean
port?
provider?|

for backward compatibility

proxmox?|null
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|null
rules?array<>|null
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

Route validated

application/json
  1. response
details?|null
message?string
Example Request
curl -X POST 'https://example.com/api/v1/route/validate' \  -H 'Content-Type: application/yaml' \  -d '{}'
Example Response
{  "details": {    "property1": null,    "property2": null  },  "message": "string"}