5.21.2 Alertmanager health check
- Description
-
Perform a health check of Alertmanager.
The status code always returns 200.
- Format
-
- Request line
GET /-/healthy HTTP/1.1
- Request header
-
Header name
Setup values
Host
Specifies value of the header for Alertmanager host to which API is connected, in the following format:
Host name or IP address:Port number
":Port number" is optional.
-
Host name or IP address
Specifies host name or IPv4 address of Alertmanager.
-
Port number
Specifies port number to use when connecting to Alertmanager.
This header is not optional.
-
- Request message body
-
None
- Status codes
-
Always return 200.
- Examples
-
The following is an example of using this API using the OSS curl command.
If Alertmanager is working properly:
>curl -I --request GET "http://localhost:20714/-/healthy" HTTP/1.1 200 OK Date: Sat, 07 Aug 2021 01:20:57 GMT Content-Length: 23 Content-Type: text/plain; charset=utf-8 >
If Alertmanager is not working properly:
>curl -I --request GET "http://localhost:20714/-/healthy" curl: (7) Failed to connect to localhost port 20714: Connection refused >