Get Alerting framework health API
editGet Alerting framework health API
editRetrieve the health status of the Alerting framework.
Request
editGET <kibana host>:<port>/api/alerting/_health
GET <kibana host>:<port>/s/<space_id>/api/alerting/_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/alerting/_health
The API returns the following:
{ "is_sufficiently_secure":true, "has_permanent_encryption_key":true, "alerting_framework_health":{ "decryption_health":{ "status":"ok", "timestamp":"2021-02-10T23:35:04.949Z" }, "execution_health":{ "status":"ok", "timestamp":"2021-02-10T23:35:04.949Z" }, "read_health":{ "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: |
alerting_framework_health
consists of the following properties:
|
Returns the timestamp and status of the rule decryption: |
|
Returns the timestamp and status of the rule execution: |
|
Returns the timestamp and status of the rule reading events: |