File: management_api.md

package info (click to toggle)
prometheus 2.24.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 18,576 kB
  • sloc: javascript: 2,471; yacc: 555; asm: 297; sh: 215; lex: 180; makefile: 157
file content (50 lines) | stat: -rw-r--r-- 1,025 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
---
title: Management API
sort_rank: 7
---

# 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.