IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete rule API List rule types API »
Elastic Docs ›Kibana Guide [7.16] ›REST API ›Alerting APIs

Find rules API

edit

Find rules API

edit

Retrieve a paginated set of rules based on condition.

As rules change in Kibana, the results on each page of the response also change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.

Request

edit

GET <kibana host>:<port>/api/alerting/rules/_find

GET <kibana host>:<port>/s/<space_id>/api/alerting/rules/_find

Path parameters

edit
space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

Query Parameters

edit

Rule params are stored as a flattened field type and analyzed as keywords.

per_page
(Optional, number) The number of rules to return per page.
page
(Optional, number) The page number.
search
(Optional, string) An Elasticsearch simple_query_string query that filters the rules in the response.
default_search_operator
(Optional, string) The operator to use for the simple_query_string. The default is OR.
search_fields
(Optional, array|string) The fields to perform the simple_query_string parsed query against.
fields
(Optional, array of strings) The fields to return in the attributes key of the response.
sort_field
(Optional, string) Sorts the response. Could be a rule field returned in the attributes key of the response.
sort_order
(Optional, string) Sort direction, either asc or desc.
has_reference
(Optional, object) Filters the rules that have a relation with the reference objects with the specific "type" and "ID".
filter
(Optional, string) 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 will have to define your filter, for example, savedObjectType.updatedAt > 2018-12-22.

Response code

edit
200
Indicates a successful call.

Examples

edit

Find rules with names that start with my:

$ curl -X GET api/alerting/rules/_find?search_fields=name&search=my*

The API returns the following:

{
  "page": 1,
  "per_page": 10,
  "total": 1,
  "data": [
    {
      "id": "0a037d60-6b62-11eb-9e0d-85d233e3ee35",
      "notify_when": "onActionGroupChange",
      "params": {
        "aggType": "avg",
      },
      "consumer": "alerts",
      "rule_type_id": "test.rule.type",
      "schedule": {
        "interval": "1m"
      },
      "actions": [],
      "tags": [],
      "name": "test rule",
      "enabled": true,
      "throttle": null,
      "api_key_owner": "elastic",
      "created_by": "elastic",
      "updated_by": "elastic",
      "mute_all": false,
      "muted_alert_ids": [],
      "updated_at": "2021-02-10T05:37:19.086Z",
      "created_at": "2021-02-10T05:37:19.086Z",
      "scheduled_task_id": "0b092d90-6b62-11eb-9e0d-85d233e3ee35",
      "execution_status": {
        "last_execution_date": "2021-02-10T17:55:14.262Z",
        "status": "ok"
      }
    },
  ]
}

For parameters that accept multiple values (e.g. fields), repeat the query parameter for each value:

$ curl -X GET api/alerting/rules/_find?fields=id&fields=name
« Delete rule API List rule types API »