File: management_api.md

package info (click to toggle)
prometheus-alertmanager 0.28.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 8,736 kB
  • sloc: makefile: 216; sh: 211; javascript: 86
file content (39 lines) | stat: -rw-r--r-- 661 bytes parent folder | download | duplicates (3)
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
---
title: Management API
sort_rank: 9
---

# Management API

Alertmanager provides a set of management API to ease automation and integrations.


### Health check

```
GET /-/healthy
HEAD /-/healthy
```

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


### Readiness check

```
GET /-/ready
HEAD /-/ready
```

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


### Reload

```
POST /-/reload
```

This endpoint triggers a reload of the Alertmanager configuration file.

An alternative way to trigger a configuration reload is by sending a `SIGHUP` to the Alertmanager process.