Traefik Labs Overview API

openapi: 3.1.0
info:
  title: Traefik Proxy REST Entrypoints Overview API
  description: 'The Traefik Proxy REST API provides read-only HTTP endpoints for inspecting the runtime configuration and state of a running Traefik instance. It exposes information about HTTP, TCP, and UDP routers, services, and middlewares, as well as entry points, raw dynamic configuration, the support-dump archive, and the current Traefik version. The API must be enabled in the Traefik static configuration (`api.insecure: true` for quick exploration, or by binding the `traefik` entrypoint behind an `IngressRoute` with `service: api@internal` for production) and should always be secured behind authentication before being exposed publicly. All endpoints listed here are mounted under the `/api` path prefix on the `traefik` entrypoint (default port 8080).'
  version: '3.7'
  contact:
    name: Traefik Labs
    url: https://traefik.io/
  license:
    name: MIT
    url: https://github.com/traefik/traefik/blob/master/LICENSE.md
servers:
- url: http://localhost:8080/api
  description: Default Traefik API endpoint (traefik entrypoint on port 8080)
tags:
- name: Overview
  description: Overview and version information for the running Traefik instance.
paths:
  /version:
    get:
      operationId: getVersion
      summary: Get Traefik Version
      description: Returns the current version of the running Traefik instance, including the version string, codename, and start date.
      tags:
      - Overview
      responses:
        '200':
          description: Version information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'
  /overview:
    get:
      operationId: getOverview
      summary: Get Overview Statistics
      description: Returns an overview of the current Traefik configuration including counts of HTTP, TCP, and UDP routers, services, and middlewares, as well as enabled features and provider information.
      tags:
      - Overview
      responses:
        '200':
          description: Overview returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Overview'
  /rawdata:
    get:
      operationId: getRawData
      summary: Get Raw Configuration Data
      description: Returns the complete raw dynamic configuration data for all routers, services, middlewares, and transports currently loaded from all providers.
      tags:
      - Overview
      responses:
        '200':
          description: Raw configuration data returned successfully
          content:
            application/json:
              schema:
                type: object
                description: Complete raw configuration data from all providers.
  /support-dump:
    get:
      operationId: getSupportDump
      summary: Get Anonymized Support Dump
      description: Returns an anonymized archive of the running Traefik configuration and runtime metadata. Used by Traefik Labs support to reproduce reported issues without exposing sensitive customer data. The endpoint returns a ZIP archive.
      tags:
      - Overview
      responses:
        '200':
          description: Support-dump archive returned successfully
          content:
            application/zip:
              schema:
                type: string
                format: binary
components:
  schemas:
    Version:
      type: object
      description: Traefik version and build information.
      properties:
        Version:
          type: string
          description: The semantic version string of the running Traefik instance.
        Codename:
          type: string
          description: The codename for this Traefik release.
        startDate:
          type: string
          format: date-time
          description: The start time of the running Traefik process.
    OverviewSection:
      type: object
      description: Counts for routers, services, and middlewares in a protocol section.
      properties:
        routers:
          $ref: '#/components/schemas/StatusCount'
        services:
          $ref: '#/components/schemas/StatusCount'
        middlewares:
          $ref: '#/components/schemas/StatusCount'
    Overview:
      type: object
      description: Overview statistics of the running Traefik instance including counts of all configured objects.
      properties:
        http:
          $ref: '#/components/schemas/OverviewSection'
        tcp:
          $ref: '#/components/schemas/OverviewSection'
        udp:
          $ref: '#/components/schemas/OverviewUDPSection'
        features:
          type: object
          description: Enabled features in the running instance.
          properties:
            tracing:
              type: string
            metrics:
              type: string
            accessLog:
              type: boolean
        providers:
          type: array
          description: List of active configuration providers.
          items:
            type: string
    OverviewUDPSection:
      type: object
      description: Counts for UDP routers and services.
      properties:
        routers:
          $ref: '#/components/schemas/StatusCount'
        services:
          $ref: '#/components/schemas/StatusCount'
    StatusCount:
      type: object
      description: Count of objects by status.
      properties:
        total:
          type: integer
        warnings:
          type: integer
        errors:
          type: integer
externalDocs:
  description: Traefik API Documentation
  url: https://doc.traefik.io/traefik/operations/api/