Get the alerting framework health

Base URL: https://{kibana_url}

GET /api/alerting/_health

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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Responses

Indicates a successful call.

application/json

Authorization information is missing or invalid.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/alerting/_health

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/alerting/_health" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "alerting_framework_health": {
    "decryption_health": {
      "status": "ok",
      "timestamp": "2023-01-13T01:28:00.280Z"
    },
    "execution_health": {
      "status": "ok",
      "timestamp": "2023-01-13T01:28:00.280Z"
    },
    "read_health": {
      "status": "ok",
      "timestamp": "2023-01-13T01:28:00.280Z"
    }
  },
  "has_permanent_encryption_key": true,
  "is_sufficiently_secure": true
}

{
  "error": "Unauthorized",
  "message": "[security_exception] missing authentication credentials for REST request",
  "statusCode": 401
}