CAUTION: This page documents an old version of Prometheus. Check out the latest stable version.

Management API

Prometheus provides a set of management APIs to facilitate automation and integration.

Health check

  1. GET /-/healthy
  2. HEAD /-/healthy

This endpoint always returns 200 and should be used to check Prometheus health.

Readiness check

  1. GET /-/ready
  2. HEAD /-/ready

This endpoint returns 200 when Prometheus is ready to serve traffic (i.e. respond to queries).

Reload

  1. PUT  /-/reload
  2. POST /-/reload

This endpoint triggers a reload of the Prometheus configuration and rule files. It’s disabled by default and can be enabled via the --web.enable-lifecycle flag.

Alternatively, a configuration reload can be triggered by sending a SIGHUP to the Prometheus process.

Quit

  1. PUT  /-/quit
  2. POST /-/quit

This endpoint triggers a graceful shutdown of Prometheus. It’s disabled by default and can be enabled via the --web.enable-lifecycle flag.

Alternatively, a graceful shutdown can be triggered by sending a SIGTERM to the Prometheus process.

This documentation is open-source. Please help improve it by filing issues or pull requests.