Skip to main content
Use the Validate endpoint to check whether a proposed router configuration is well-formed before applying it. Submit either a raw YAML string or a JSON config object. The endpoint returns a boolean validity flag and a list of schema errors with paths, if any. No live configuration is modified. This is useful in CI pipelines and admin dashboards to prevent invalid config rollouts.

Endpoint

Authentication

Authenticate with a session cookie or pass Authorization: Bearer <api-key>.

Request Body

string
required
Raw YAML v0.3 configuration string.
Or
object
required
JSON object matching the router config schema.

Response

boolean
Whether the submitted configuration passes schema validation.
array
List of validation errors. Empty when valid is true.