+
+
Up
+
get /s/{spaceId}/api/alerting/rules/_find
+
Retrieves information about rules. (findRules)
+
You must have read privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rules you're seeking. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. To find rules associated with the Stack Monitoring feature, use the monitoring_user built-in role.
+
+
Path parameters
+
+
spaceId (required)
+
+
Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
+
+
+
+
+
+
Query parameters
+
+
default_search_operator (optional)
+
+
Query Parameter — The default operator to use for the simple_query_string. default: OR
fields (optional)
+
+
Query Parameter — The fields to return in the attributes key of the response. default: null
filter (optional)
+
+
Query Parameter — A KQL string that you filter with an attribute from your saved object. It should look like savedObjectType.attributes.title: "myTitle". However, if you used a direct attribute of a saved object, such as updatedAt, you must define your filter, for example, savedObjectType.updatedAt > 2018-12-22. default: null
has_reference (optional)
+
+
Query Parameter — Filters the rules that have a relation with the reference objects with a specific type and identifier. default: null
page (optional)
+
+
Query Parameter — The page number to return. default: 1
per_page (optional)
+
+
Query Parameter — The number of rules to return per page. default: 20
search (optional)
+
+
Query Parameter — An Elasticsearch simple_query_string query that filters the objects in the response. default: null
search_fields (optional)
+
+
Query Parameter — The fields to perform the simple_query_string parsed query against. default: null
sort_field (optional)
+
+
Query Parameter — Determines which field is used to sort the results. The field must exist in the attributes key of the response. default: null
sort_order (optional)
+
+
Query Parameter — Determines the sort order. default: desc
+
+
+
+
Return type
+
+
+
+
+
Example data
+
Content-Type: application/json
+
{
+ "per_page" : 2,
+ "total" : 7,
+ "data" : [ {
+ "throttle" : "10m",
+ "created_at" : "2022-12-05T23:36:58.284Z",
+ "last_run" : {
+ "alerts_count" : {
+ "new" : 0,
+ "ignored" : 6,
+ "recovered" : 1,
+ "active" : 5
+ },
+ "outcome_msg" : "outcome_msg",
+ "warning" : "warning",
+ "outcome" : "succeeded"
+ },
+ "params" : {
+ "key" : ""
+ },
+ "created_by" : "elastic",
+ "enabled" : true,
+ "muted_alert_ids" : [ "muted_alert_ids", "muted_alert_ids" ],
+ "rule_type_id" : "monitoring_alert_cluster_health",
+ "tags" : [ "tags", "tags" ],
+ "api_key_owner" : "elastic",
+ "schedule" : {
+ "interval" : "1m"
+ },
+ "notify_when" : "onActiveAlert",
+ "next_run" : "2022-12-06T00:14:43.818Z",
+ "updated_at" : "2022-12-05T23:36:58.284Z",
+ "execution_status" : {
+ "last_execution_date" : "2022-12-06T00:13:43.89Z",
+ "last_duration" : 55,
+ "status" : "ok"
+ },
+ "name" : "cluster_health_rule",
+ "updated_by" : "elastic",
+ "scheduled_task_id" : "b530fed0-74f5-11ed-9801-35303b735aef",
+ "id" : "b530fed0-74f5-11ed-9801-35303b735aef",
+ "mute_all" : false,
+ "actions" : [ {
+ "id" : "9dca3e00-74f5-11ed-9801-35303b735aef",
+ "params" : {
+ "key" : ""
+ },
+ "group" : "default"
+ }, {
+ "id" : "9dca3e00-74f5-11ed-9801-35303b735aef",
+ "params" : {
+ "key" : ""
+ },
+ "group" : "default"
+ } ],
+ "consumer" : "alerts"
+ }, {
+ "throttle" : "10m",
+ "created_at" : "2022-12-05T23:36:58.284Z",
+ "last_run" : {
+ "alerts_count" : {
+ "new" : 0,
+ "ignored" : 6,
+ "recovered" : 1,
+ "active" : 5
+ },
+ "outcome_msg" : "outcome_msg",
+ "warning" : "warning",
+ "outcome" : "succeeded"
+ },
+ "params" : {
+ "key" : ""
+ },
+ "created_by" : "elastic",
+ "enabled" : true,
+ "muted_alert_ids" : [ "muted_alert_ids", "muted_alert_ids" ],
+ "rule_type_id" : "monitoring_alert_cluster_health",
+ "tags" : [ "tags", "tags" ],
+ "api_key_owner" : "elastic",
+ "schedule" : {
+ "interval" : "1m"
+ },
+ "notify_when" : "onActiveAlert",
+ "next_run" : "2022-12-06T00:14:43.818Z",
+ "updated_at" : "2022-12-05T23:36:58.284Z",
+ "execution_status" : {
+ "last_execution_date" : "2022-12-06T00:13:43.89Z",
+ "last_duration" : 55,
+ "status" : "ok"
+ },
+ "name" : "cluster_health_rule",
+ "updated_by" : "elastic",
+ "scheduled_task_id" : "b530fed0-74f5-11ed-9801-35303b735aef",
+ "id" : "b530fed0-74f5-11ed-9801-35303b735aef",
+ "mute_all" : false,
+ "actions" : [ {
+ "id" : "9dca3e00-74f5-11ed-9801-35303b735aef",
+ "params" : {
+ "key" : ""
+ },
+ "group" : "default"
+ }, {
+ "id" : "9dca3e00-74f5-11ed-9801-35303b735aef",
+ "params" : {
+ "key" : ""
+ },
+ "group" : "default"
+ } ],
+ "consumer" : "alerts"
+ } ],
+ "page" : 5
+}
+
+
Produces
+ This API call produces the following media types according to the request header;
+ the media type will be conveyed by the response header.
+
+
+
Responses
+
200
+ Indicates a successful call.
+
findRules_200_response
+