Get Alerting framework health API
editGet Alerting framework health API
editRetrieve the health status of the Alerting framework.
Request
editGET <kibana host>:<port>/api/alerts/_health
GET <kibana host>:<port>/s/<space_id>/api/alerts/_health
Path parameters
edit-
space_id
-
(Optional, string) An identifier for the space. If
space_id
is not provided in the URL, the default space is used.
Response code
edit-
200
- Indicates a successful call.
Example
editRetrieve the health status of the Alerting framework:
$ curl -X GET api/alerts/_health
The API returns the following:
{ "isSufficientlySecure":true, "hasPermanentEncryptionKey":true, "alertingFrameworkHeath":{ "decryptionHealth":{ "status":"ok", "timestamp":"2021-02-10T23:35:04.949Z" }, "executionHealth":{ "status":"ok", "timestamp":"2021-02-10T23:35:04.949Z" }, "readHealth":{ "status":"ok", "timestamp":"2021-02-10T23:35:04.949Z" } } }
The health API response contains the following properties:
|
Returns |
|
Return the state |
|
This state property has three substates that identify the health of the alerting framework API: |
alertingFrameworkHeath
consists of the following properties:
|
Returns the timestamp and status of the alert decryption: |
|
Returns the timestamp and status of the alert execution: |
|
Returns the timestamp and status of the alert reading events: |