Ping

    To enable the API handler:

    File (YAML)

    File (TOML)

    1. [ping]

    CLI

    1. --ping=true

    Configuration Options

    The /ping health-check URL is enabled with the command-line --ping or config file option [ping].

    The entryPoint where the /ping is active can be customized with the entryPoint option, whose default value is traefik (port 8080).

    Note

    Optional, Default=”traefik”

    Enabling /ping on a dedicated EntryPoint.

    File (YAML)

    1.   ping:
    2.     address: ":8082"
    4. ping:
    5.   entryPoint: "ping"

    File (TOML)

    CLI

    1. --entryPoints.ping.address=:8082
    2. --ping.entryPoint=ping

    Optional, Default=false

    If manualRouting is true, it disables the default internal router in order to allow one to create a custom router for the ping@internal service.

    1.   manualRouting: true

    File (TOML)

    1. [ping]
    2.   manualRouting = true

    CLI

    Optional, Default=503

    During the period in which Traefik is gracefully shutting down, the ping handler returns a 503 status code by default. If Traefik is behind e.g. a load-balancer doing health checks (such as the Kubernetes LivenessProbe), another code might be expected as the signal for graceful termination. In which case, the terminatingStatusCode can be used to set the code returned by the ping handler during termination.

    File (YAML)

    1. ping:
    2.   terminatingStatusCode: 204

    File (TOML)

    1. [ping]
    2.   terminatingStatusCode = 204

    CLI