Get the alerting framework health Deprecated

View as Markdown
GET /api/alerts/alerts/_health
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/alerts/alerts/_health

Refer to Spaces for more information.

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

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • alertingFrameworkHealth object

      Three substates identify the health of the alerting framework: decryptionHealth, executionHealth, and readHealth.

      Hide alertingFrameworkHealth attributes Show alertingFrameworkHealth attributes object
      • decryptionHealth object

        The timestamp and status of the alert decryption.

        Hide decryptionHealth attributes Show decryptionHealth attributes object
        • status string

          Values are error, ok, or warn.

        • timestamp string(date-time)
      • executionHealth object

        The timestamp and status of the alert execution.

        Hide executionHealth attributes Show executionHealth attributes object
        • status string

          Values are error, ok, or warn.

        • timestamp string(date-time)
      • readHealth object

        The timestamp and status of the alert reading events.

        Hide readHealth attributes Show readHealth attributes object
        • status string

          Values are error, ok, or warn.

        • timestamp string(date-time)
    • hasPermanentEncryptionKey boolean

      If false, the encrypted saved object plugin does not have a permanent encryption key.

    • isSufficientlySecure boolean

      If false, security is enabled but TLS is not.
  • 401 application/json

    Authorization information is missing or invalid.

    Hide response attributes Show response attributes object
    • error string

      Value is Unauthorized.

    • message string
    • statusCode integer

      Value is 401.
GET /api/alerts/alerts/_health 
curl \
 --request GET 'https://localhost:5601/api/alerts/alerts/_health' \
 --header "Authorization: $API_KEY"