IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Get alerting framework health API

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get alerting framework health API

edit

Retrieve the health status of the alerting framework.

Request

edit

GET <kibana host>:<port>/api/alerting/_health

GET <kibana host>:<port>/s/<space_id>/api/alerting/_health

Prerequisites

edit

You 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

edit

Retrieve 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"
      }
   },
   "alerting_framework_heath":{ 
      "_deprecated":"This state property has a typo, use \"alerting_framework_health\" instead.","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"
      }
   }
}

	`is_sufficiently_secure` is `false` when security is enabled, but TLS is not.
	`has_permanent_encryption_key` is `false` when the encrypted saved object plugin does not have a permanent encryption key.
	`alerting_framework_health` has three substates that identify the health of the alerting framework: `decryption_health`, `execution_health`, and `read_health`. `decryption_health` returns the timestamp and status of the rule decryption: `ok`, `warn` or `error`. `execution_health` returns the timestamp and status of the rule execution: `ok`, `warn` or `error`. `read_health` returns the timestamp and status of the rule reading events: `ok`, `warn` or `error`.
	`alerting_framework_heath` has a typo, use `alerting_framework_health` instead. [8.0.0] Deprecated in 8.0.0.

« Find rules API Get rule API »