Retrieve the status of prebuilt detection rules and Timelines

Base URL: https://{kibana_url}

GET /api/detection_engine/rules/prepackaged/_status

Retrieve the status of all Elastic prebuilt detection rules and Timelines.

This endpoint provides detailed information about the number of custom rules, installed prebuilt rules, available prebuilt rules that are not installed, outdated prebuilt rules, installed prebuilt timelines, available prebuilt timelines that are not installed, and outdated prebuilt timelines.

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>

Response

Indicates a successful call

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/detection_engine/rules/prepackaged/_status

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/detection_engine/rules/prepackaged/_status" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "rules_custom_installed": 0,
  "rules_installed": 0,
  "rules_not_installed": 112,
  "rules_not_updated": 0,
  "timelines_installed": 0,
  "timelines_not_installed": 0,
  "timelines_not_updated": 0
}