Get Alerting framework health APIedit

Retrieve the health status of the Alerting framework.

Requestedit

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

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

Path parametersedit

space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

Response codeedit

200
Indicates a successful call.

Exampleedit

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

isSufficientlySecure

Returns false if security is enabled, but TLS is not.

hasPermanentEncryptionKey

Return the state false if Encrypted Saved Object plugin has not a permanent encryption Key.

alertingFrameworkHeath

This state property has three substates that identify the health of the alerting framework API: decryptionHealth, executionHealth, and readHealth.

alertingFrameworkHeath consists of the following properties:

decryptionHealth

Returns the timestamp and status of the alert decryption: ok, warn or error .

executionHealth

Returns the timestamp and status of the alert execution: ok, warn or error.

readHealth

Returns the timestamp and status of the alert reading events: ok, warn or error.