{"openapi":"3.1.0","info":{"title":"Traefik API","description":"Reverse proxy and load balancer API for routing and service discovery.\n\n**Version note:** Running Traefik v3.x. REST API paths (`/api/*`, `/ping`)\nare unchanged from v2, but router/middleware config keys differ. See the\n[v2→v3 migration guide](https://doc.traefik.io/traefik/migration/v2-to-v3/).\nA deeper v3 API-path review of this spec is a tracked follow-up, NOT done\nhere.\n","version":"v3.6","contact":{"name":"Traefik Project","url":"https://traefik.io"},"license":{"name":"MIT","url":"https://github.com/traefik/traefik/blob/master/LICENSE.md"}},"servers":[{"url":"https://traefik.haiven.site","description":"Traefik dashboard over HTTPS"},{"url":"http://traefik:8080","description":"Traefik API internal Docker"}],"tags":[{"name":"Overview","description":"High-level statistics and system information"},{"name":"HTTP","description":"HTTP routers, services, and middlewares"},{"name":"TCP","description":"TCP routers, services, and middlewares"},{"name":"UDP","description":"UDP routers and services"},{"name":"Entrypoints","description":"Network entry points into Traefik"},{"name":"Health","description":"Health check endpoint"}],"paths":{"/api/overview":{"get":{"tags":["Overview"],"summary":"Get Traefik overview","description":"Provides statistics on HTTP, TCP, UDP configurations","operationId":"getOverview","responses":{"200":{"description":"Overview statistics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Overview"}}}}}}},"/api/version":{"get":{"tags":["Overview"],"summary":"Get Traefik version","operationId":"getVersion","responses":{"200":{"description":"Version information","content":{"application/json":{"schema":{"type":"object","properties":{"Version":{"type":"string"},"Codename":{"type":"string"},"GoVersion":{"type":"string"}}}}}}}}},"/api/rawdata":{"get":{"tags":["Overview"],"summary":"Get raw configuration data","operationId":"getRawData","responses":{"200":{"description":"Raw configuration data","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/api/entrypoints":{"get":{"tags":["Entrypoints"],"summary":"List all entrypoints","operationId":"listEntrypoints","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"List of entrypoints","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Entrypoint"}}}}}}}},"/api/entrypoints/{name}":{"get":{"tags":["Entrypoints"],"summary":"Get specific entrypoint","operationId":"getEntrypoint","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Entrypoint details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entrypoint"}}}},"404":{"description":"Entrypoint not found"}}}},"/api/http/routers":{"get":{"tags":["HTTP"],"summary":"List HTTP routers","operationId":"listHttpRouters","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"List of HTTP routers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HttpRouter"}}}}}}}},"/api/http/routers/{name}":{"get":{"tags":["HTTP"],"summary":"Get specific HTTP router","operationId":"getHttpRouter","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"HTTP router details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpRouter"}}}},"404":{"description":"Router not found"}}}},"/api/http/services":{"get":{"tags":["HTTP"],"summary":"List HTTP services","operationId":"listHttpServices","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"List of HTTP services","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HttpService"}}}}}}}},"/api/http/services/{name}":{"get":{"tags":["HTTP"],"summary":"Get specific HTTP service","operationId":"getHttpService","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"HTTP service details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpService"}}}},"404":{"description":"Service not found"}}}},"/api/http/middlewares":{"get":{"tags":["HTTP"],"summary":"List HTTP middlewares","operationId":"listHttpMiddlewares","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"List of HTTP middlewares","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HttpMiddleware"}}}}}}}},"/api/http/middlewares/{name}":{"get":{"tags":["HTTP"],"summary":"Get specific HTTP middleware","operationId":"getHttpMiddleware","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"HTTP middleware details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpMiddleware"}}}},"404":{"description":"Middleware not found"}}}},"/api/tcp/routers":{"get":{"tags":["TCP"],"summary":"List TCP routers","operationId":"listTcpRouters","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"List of TCP routers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TcpRouter"}}}}}}}},"/api/tcp/services":{"get":{"tags":["TCP"],"summary":"List TCP services","operationId":"listTcpServices","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"List of TCP services","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TcpService"}}}}}}}},"/api/udp/routers":{"get":{"tags":["UDP"],"summary":"List UDP routers","operationId":"listUdpRouters","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"List of UDP routers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UdpRouter"}}}}}}}},"/api/udp/services":{"get":{"tags":["UDP"],"summary":"List UDP services","operationId":"listUdpServices","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PerPage"}],"responses":{"200":{"description":"List of UDP services","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UdpService"}}}}}}}},"/ping":{"get":{"tags":["Health"],"summary":"Health check","operationId":"ping","responses":{"200":{"description":"Traefik is healthy","content":{"text/plain":{"schema":{"type":"string","example":"OK"}}}}}}}},"components":{"parameters":{"Page":{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},"PerPage":{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":100}}},"schemas":{"Overview":{"type":"object","properties":{"http":{"type":"object","properties":{"routers":{"type":"object","properties":{"total":{"type":"integer"},"warnings":{"type":"integer"},"errors":{"type":"integer"}}},"services":{"type":"object","properties":{"total":{"type":"integer"},"warnings":{"type":"integer"},"errors":{"type":"integer"}}},"middlewares":{"type":"object","properties":{"total":{"type":"integer"},"warnings":{"type":"integer"},"errors":{"type":"integer"}}}}},"tcp":{"type":"object"},"udp":{"type":"object"},"features":{"type":"object","additionalProperties":{"type":"string"}}}},"Entrypoint":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"http":{"type":"object"},"transport":{"type":"object"}}},"HttpRouter":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string","enum":["enabled","disabled","warning","error"]},"using":{"type":"array","items":{"type":"string"}},"rule":{"type":"string"},"priority":{"type":"integer"},"service":{"type":"string"},"middlewares":{"type":"array","items":{"type":"string"}},"tls":{"type":"object"}}},"HttpService":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string","enum":["enabled","disabled","warning","error"]},"type":{"type":"string","enum":["loadbalancer","weighted","mirroring"]},"loadBalancer":{"type":"object","properties":{"servers":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"}}}},"passHostHeader":{"type":"boolean"}}},"usedBy":{"type":"array","items":{"type":"string"}}}},"HttpMiddleware":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string","enum":["enabled","disabled","warning","error"]},"type":{"type":"string"},"config":{"type":"object","additionalProperties":true},"usedBy":{"type":"array","items":{"type":"string"}}}},"TcpRouter":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"using":{"type":"array","items":{"type":"string"}},"rule":{"type":"string"},"service":{"type":"string"},"tls":{"type":"object"}}},"TcpService":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"loadBalancer":{"type":"object","properties":{"servers":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"}}}}}}}},"UdpRouter":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"using":{"type":"array","items":{"type":"string"}},"service":{"type":"string"}}},"UdpService":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"loadBalancer":{"type":"object","properties":{"servers":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"}}}}}}}}}}}