kibana_wip2

Retrieve the status of prebuilt detection rules and Timelines

GET /api/detection_engine/rules/prepackaged/_status
Basic auth

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.

Responses

  • 200 application/json

    Indicates a successful call

    Hide response attributes Show response attributes object
    • rules_custom_installed integer Required

      The total number of custom rules

      Minimum value is 0.

    • rules_installed integer Required

      The total number of installed prebuilt rules

      Minimum value is 0.

    • rules_not_installed integer Required

      The total number of available prebuilt rules that are not installed

      Minimum value is 0.

    • rules_not_updated integer Required

      The total number of outdated prebuilt rules

      Minimum value is 0.

    • timelines_installed integer Required

      The total number of installed prebuilt timelines

      Minimum value is 0.

    • timelines_not_installed integer Required

      The total number of available prebuilt timelines that are not installed

      Minimum value is 0.

    • timelines_not_updated integer Required

      The total number of outdated prebuilt timelines

      Minimum value is 0.
GET /api/detection_engine/rules/prepackaged/_status 
curl \
 --request GET 'http://localhost:5601/api/detection_engine/rules/prepackaged/_status' \
 --user "username:password"
Response examples (200) 
{
  "rules_installed": 0,
  "rules_not_updated": 0,
  "rules_not_installed": 112,
  "timelines_installed": 0,
  "timelines_not_updated": 0,
  "rules_custom_installed": 0,
  "timelines_not_installed": 0
}