Get the alerting framework health Deprecated

GET /api/alerts/alerts/_health

Deprecated in 7.13.0. Use the get alerting framework health API instead.

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • Three substates identify the health of the alerting framework: decryptionHealth, executionHealth, and readHealth.

      Hide alertingFrameworkHealth attributes Show alertingFrameworkHealth attributes object
      • The timestamp and status of the alert decryption.

        Hide decryptionHealth attributes Show decryptionHealth attributes object
      • The timestamp and status of the alert execution.

        Hide executionHealth attributes Show executionHealth attributes object
      • The timestamp and status of the alert reading events.

        Hide readHealth attributes Show readHealth attributes object
    • If false, the encrypted saved object plugin does not have a permanent encryption key.

    • If false, security is enabled but TLS is not.

  • 401 application/json; Elastic-Api-Version=2023-10-31

    Authorization information is missing or invalid.

    Hide response attributes Show response attributes object
GET /api/alerts/alerts/_health
curl \
 -X GET https://localhost:5601/api/alerts/alerts/_health
Response examples (200)
{
  "alertingFrameworkHealth": {
    "decryptionHealth": {
      "status": "ok",
      "timestamp": "2023-01-13T01:28:00.280Z"
    },
    "executionHealth": {
      "status": "ok",
      "timestamp": "2023-01-13T01:28:00.280Z"
    },
    "readHealth": {
      "status": "ok",
      "timestamp": "2023-01-13T01:28:00.280Z"
    }
  },
  "hasPermanentEncryptionKey": true,
  "isSufficientlySecure": true
}
Response examples (401)
{
  "error": "Unauthorized",
  "message": "string",
  "statusCode": 401
}