• CLI
    • General
      • healthcheck
      • version

    CLI

    The Traefik Command Line

    General

    1. traefik [command] [flags] [arguments]

    Use traefik [command] —help for help on any command.

    Commands:

    • healthcheck Calls Traefik /ping to check the health of Traefik (the API must be enabled).
    • version Shows the current Traefik version.Flag's usage:
    1. # set flag_argument to flag(s)
    2. traefik [--flag=flag_argument] [-f [flag_argument]]
    4. # set true/false to boolean flag(s)
    5. traefik [--flag[=true|false| ]] [-f [true|false| ]]

    healthcheck

    Calls Traefik /ping to check the health of Traefik.Its exit status is 0 if Traefik is healthy and 1 otherwise.

    This can be used with Docker HEALTHCHECK instructionor any other health check orchestration mechanism.

    Note

    The ping endpoint must be enabled to allow the healthcheck command to call /ping.

    Usage:

    1. traefik healthcheck [command] [flags] [arguments]

    Example:

    1. $ traefik healthcheck
    2. OK: http://:8082/ping

    version

    Shows the current Traefik version.

    Usage:

    1. traefik version