prometheus/docs/management_api.md
Julius Volz 4a5aef0495
Merge release-2.28 back into main (#8975)
* Cut v2.28.0-rc.0 (#8954)

* Cut v2.28.0-rc.0

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Changelog fixup

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Address review comments

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Downgrade some features to enhancements

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Adjust release date to today

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Migrate HTTP SD docs from docs repo (#8972)

See discussion in https://github.com/prometheus/docs/pull/1975

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Cut Prometheus v2.28.0 (#8973)

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2021-06-22 00:59:31 +02:00

51 lines
1.0 KiB
Markdown

---
title: Management API
sort_rank: 8
---
# Management API
Prometheus provides a set of management APIs to facilitate automation and integration.
### Health check
```
GET /-/healthy
```
This endpoint always returns 200 and should be used to check Prometheus health.
### Readiness check
```
GET /-/ready
```
This endpoint returns 200 when Prometheus is ready to serve traffic (i.e. respond to queries).
### Reload
```
PUT /-/reload
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
```
PUT /-/quit
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.