Get alerting framework health API
editGet alerting framework health API
editRetrieve the health status of the alerting framework.
For the most up-to-date API details, refer to the open API specification.
Request
editGET <kibana host>:<port>/api/alerting/_health
GET <kibana host>:<port>/s/<space_id>/api/alerting/_health
Prerequisites
editYou must have read
privileges for the Management > Stack Rules feature or
for at least one of the Analytics > Discover, Analytics > Machine Learning,
Observability, or Security features.
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 codes
edit-
200
- Indicates a successful call.
Examples
editRetrieve the health status of the alerting framework:
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":"2022-06-21T21:46:15.023Z" }, "execution_health":{ "status":"ok", "timestamp":"2022-06-21T21:46:15.023Z" }, "read_health":{ "status":"ok", "timestamp":"2022-06-21T21:46:15.023Z" } } }
|
|
|
|
|