Tool to retrieve a list of alerting rules in Kibana. Use when you need to get a paginated set of rules based on specified conditions.
pageintegerPage number to return. Minimum value is 1; default is 1.
fieldsarrayFields to return in the `attributes` key of the response.
filterstringA KQL string to filter with an attribute from your saved object.
searchstringAn Elasticsearch `simple_query_string` to filter the rules.
per_pageintegerNumber of rules to return per page. Minimum value is 0; default is 10.
sort_fieldstringField used to sort the results; must exist in the `attributes` key of the response.
sort_orderstringSort order.
has_referenceobjectFilters rules with a relation to reference objects of a specific type and identifier.
search_fieldsFields to perform the `simple_query_string` query against.
filter_consumersarrayList of consumers to filter.
default_search_operatorstringDefault operator for the `simple_query_string`. Default is `OR`.
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.