Get the alerting framework health

Base URL
https://{kibana_url}
  • GET /api/alerting/_health
Auth

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

Indicates a successful call.

application/json
alerting_framework_health object

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

decryption_health object

The timestamp and status of the rule decryption.

status enum
Values: error ok warn
timestamp string · format: date-time
execution_health object

The timestamp and status of the rule run.

status enum
Values: error ok warn
timestamp string · format: date-time
read_health object

The timestamp and status of the rule reading events.

status enum
Values: error ok warn
timestamp string · format: 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.

Authorization information is missing or invalid.

application/json
error enum
Values: Unauthorized
message string
statusCode enum
Values: 401
Base URL
https://{kibana_url}