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

« Unmute alert API Deprecated 7.x APIs »

› › ›

Get Alerting framework health API

edit

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

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

edit

Retrieve 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:

`is_sufficiently_secure`	Returns `false` if security is enabled, but TLS is not.
`has_permanent_encryption_key`	Return the state `false` if Encrypted Saved Object plugin has not a permanent encryption Key.
`alerting_framework_health`	This state property has three substates that identify the health of the alerting framework API: `decryption_health`, `execution_health`, and `read_health`.

alerting_framework_health consists of the following properties:

`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`.

« Unmute alert API Deprecated 7.x APIs »