Skip to content

API endpoints

The panel exposes a small HTTP API. The most important ones are the machine endpoints Traefik calls; the rest back the UI.

Traefik integration

MethodPathPurpose
GET/api/traefik/configDynamic configuration (the HTTP-provider endpoint Traefik polls). Routers, services, middlewares.
GET/api/traefik/static-configStatic traefik.yml — managed mode only; 404 otherwise. Read by the bundle's wrapper.
GET/api/traefik/managedManaged-mode state: whether managed, the static config, credential names, and applied/pending status. PUT to update the static config.
GET/api/traefik/managed/secrets-envDNS credentials as a shell env file, for the in-network wrapper only — refused via the public domain.
PUT/api/traefik/managed/secretsApply a write-only credential edit batch (returns names only).
GET/api/traefik/entrypointsEntrypoints discovered from Traefik's API.
GET/api/traefik/middlewaresMiddlewares discovered from Traefik's API.
GET/api/traefik/cert-resolversCertificate-resolver names inferred from routers/entrypoints (and managed config).
GET/api/traefik/runtimeLive runtime snapshot (routers/services/middlewares/entrypoints).
GET/api/traefik/metricsPer-service traffic metrics.
GET/api/traefik/conflictsRoute-conflict report.
GET/api/traefik/certificatesLoaded certificates (Traefik v3.7+).
GET/api/traefik/healthBackend health for services.

Services

MethodPathPurpose
GET/api/servicesList services.
POST/api/servicesCreate a service.
PUT/api/services/[id]Update a service.
DELETE/api/services/[id]Delete a service.
GET/POST/DELETE/api/services/[id]/security-configsPer-service security (basic auth, SSO, shared links).

Domains

MethodPathPurpose
GET/api/domainsList domains.
POST/api/domainsCreate a domain.
PUT/api/domains/[id]Update a domain.
DELETE/api/domains/[id]Delete a domain.

Authentication & sessions

MethodPathPurpose
GET/api/auth/verifyForward-auth endpoint Traefik calls per request.
GET/api/sessionsList active sessions.
DELETE/api/sessionsDelete all sessions.

Global config & system

MethodPathPurpose
GET/api/configGlobal configuration (admin panel domain, default entrypoints, global middlewares).
PUT/api/configUpdate global configuration.
GET/api/systemLightweight flags for the UI (e.g. whether managed mode is on).
GET/api/healthHealth check (used by the container healthcheck).

INFO

Endpoint shapes can evolve; treat GET /api/traefik/config and GET /api/auth/verify as the stable integration contract with Traefik. The rest exist primarily for the UI.

Released under the AGPL-3.0 License.