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 instance API Action and connector APIs »

› › ›

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/alerts/_health

GET <kibana host>:<port>/s/<space_id>/api/alerts/_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/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`.

« Unmute alert instance API Action and connector APIs »