Retrieves a paginated list of Kibana detection engine rules with flexible filtering and sorting options. Use this action to: - List all detection rules in your Kibana security solution - Search for specific rules using KQL filters (by name, tags, severity, enabled status, etc.)…
pageintegerPage number for pagination, starting at 1. Use with per_page to navigate through large result sets. Defaults to 1.
fieldsarrayList of specific fields to include in the response. If not specified, all fields are returned. Common fields: 'id', 'name', 'enabled', 'type', 'severity', 'risk_score', 'tags'.
filterstringKQL (Kibana Query Language) filter to narrow down results. Filter by name, enabled status, tags, creator, interval, or updater. Use 'and'/'or' operators for complex queries.
per_pageintegerNumber of rules to return per page (0-10000). Set to 0 to return only metadata without rules. Defaults to 20.
sort_fieldstringField name to sort results by. Common options: 'name', 'created_at', 'updated_at', 'enabled', 'risk_score', 'severity'. Only used when specified (omit for default ordering).
sort_orderstringSort direction: 'asc' (ascending) or 'desc' (descending). Defaults to 'desc'. Only applied when sort_field is specified.
gaps_range_endstringEnd of time range for gap analysis (ISO 8601 format). Used to identify execution gaps in rules. Must be used with gaps_range_start. Example: '2024-12-31T23:59:59Z'.
gaps_range_startstringStart of time range for gap analysis (ISO 8601 format). Used to identify execution gaps in rules. Must be used with gaps_range_end. Example: '2024-01-01T00:00:00Z'.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.