Traefik Labs UDP API

openapi: 3.1.0
info:
  title: Traefik Proxy REST Entrypoints UDP 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: UDP
  description: Endpoints for inspecting UDP routers and services.
paths:
  /udp/routers:
    get:
      operationId: listUDPRouters
      summary: List All UDP Routers
      description: Returns a list of all UDP routers configured in the running Traefik instance.
      tags:
      - UDP
      parameters:
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/status'
      - $ref: '#/components/parameters/per_page'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: UDP routers returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UDPRouter'
  /udp/routers/{name}:
    get:
      operationId: getUDPRouter
      summary: Get a Specific UDP Router
      description: Returns the configuration of a specific UDP router by its name.
      tags:
      - UDP
      parameters:
      - name: name
        in: path
        required: true
        description: The name of the UDP router, in the format name@provider.
        schema:
          type: string
      responses:
        '200':
          description: UDP router returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UDPRouter'
        '404':
          description: Router not found
  /udp/services:
    get:
      operationId: listUDPServices
      summary: List All UDP Services
      description: Returns a list of all UDP services configured in the running Traefik instance.
      tags:
      - UDP
      parameters:
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/status'
      - $ref: '#/components/parameters/per_page'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: UDP services returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UDPService'
  /udp/services/{name}:
    get:
      operationId: getUDPService
      summary: Get a Specific UDP Service
      description: Returns the configuration of a specific UDP service by its name.
      tags:
      - UDP
      parameters:
      - name: name
        in: path
        required: true
        description: The name of the UDP service, in the format name@provider.
        schema:
          type: string
      responses:
        '200':
          description: UDP service returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UDPService'
        '404':
          description: Service not found
components:
  parameters:
    search:
      name: search
      in: query
      required: false
      description: Filter results by name using a search string.
      schema:
        type: string
    status:
      name: status
      in: query
      required: false
      description: Filter results by status (enabled or disabled).
      schema:
        type: string
        enum:
        - enabled
        - disabled
    per_page:
      name: per_page
      in: query
      required: false
      description: Number of results per page.
      schema:
        type: integer
        default: 100
    page:
      name: page
      in: query
      required: false
      description: Page number for paginated results.
      schema:
        type: integer
        default: 1
  schemas:
    UDPService:
      type: object
      description: A UDP service representing one or more backend UDP servers.
      properties:
        name:
          type: string
          description: The name of the UDP service in name@provider format.
        type:
          type: string
        status:
          type: string
          enum:
          - enabled
          - disabled
          - warning
        provider:
          type: string
        loadBalancer:
          type: object
          properties:
            servers:
              type: array
              items:
                type: object
                properties:
                  address:
                    type: string
                    description: The address of the backend UDP server (host:port).
    UDPRouter:
      type: object
      description: A UDP router that routes incoming UDP datagrams to services.
      properties:
        name:
          type: string
          description: The name of the UDP router in name@provider format.
        entryPoints:
          type: array
          items:
            type: string
        service:
          type: string
          description: The UDP service this router routes traffic to.
        status:
          type: string
          enum:
          - enabled
          - disabled
          - warning
        provider:
          type: string
externalDocs:
  description: Traefik API Documentation
  url: https://doc.traefik.io/traefik/operations/api/