Get the alerting framework health

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

Spaces method and path for this operation:

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

Refer to Spaces for more information.

You must have read privileges for the Management > Stack Rules feature or for at least one of the Analytics > Discover, Analytics > Machine Learning, Observability, or Security features.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • alerting_framework_health object

      Three substates identify the health of the alerting framework: decryption_health, execution_health, and read_health.

      Hide alerting_framework_health attributes Show alerting_framework_health attributes object
      • decryption_health object

        The timestamp and status of the rule decryption.

        Hide decryption_health attributes Show decryption_health attributes object
        • status string

          Values are error, ok, or warn.

        • timestamp string(date-time)
      • execution_health object

        The timestamp and status of the rule run.

        Hide execution_health attributes Show execution_health attributes object
        • status string

          Values are error, ok, or warn.

        • timestamp string(date-time)
      • read_health object

        The timestamp and status of the rule reading events.

        Hide read_health attributes Show read_health attributes object
        • status string

          Values are error, ok, or warn.

        • timestamp string(date-time)
    • has_permanent_encryption_key boolean

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

    • is_sufficiently_secure 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/alerting/_health 
curl \ --request GET 'https://localhost:5601/api/alerting/_health' \ --header "Authorization: $API_KEY"
Response examples (200) 
{ "is_sufficiently_secure": true, "alerting_framework_health": { "read_health": { "status": "ok", "timestamp": "2023-01-13T01:28:00.280Z" }, "execution_health": { "status": "ok", "timestamp": "2023-01-13T01:28:00.280Z" }, "decryption_health": { "status": "ok", "timestamp": "2023-01-13T01:28:00.280Z" } }, "has_permanent_encryption_key": true }