Skip to main content
Read or replace the live router configuration. GET returns the current YAML v0.3 config as JSON. PUT replaces the whole config with a validated object. Only admins can write. The configuration is organized into top-level blocks: listeners, providers, entrypoints, recipes, and global.

Endpoint

Authentication

Authenticate with a session cookie or pass Authorization: Bearer <api-key>. The PUT method requires an admin role.

GET Response

object
The current router configuration.

PUT Request Body

array
Bind addresses and ports.
array
required
Provider definitions.
array
required
Virtual model mappings.
array
required
Routing recipes.
object
required
Global settings.

PUT Response

boolean
Whether the new configuration was accepted and applied.