IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Enable rule API Get alerting framework health API »

› › ›

Find rules API

edit

Find rules API

edit

Retrieve a paginated set of rules based on condition.

Request

edit

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

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

Prerequisites

edit

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, the Management > Stack Rules feature, Analytics > Discover and Machine Learning features, Observability, and Security features. To find rules associated with the Stack Monitoring feature, use the monitoring_user built-in role.

For more details, refer to Feature privileges.

Description

edit

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.

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

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

default_search_operator: (Optional, string) The operator to use for the simple_query_string. The default is OR.
fields: (Optional, array of strings) The fields to return in the attributes key of the response.
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.
has_reference: (Optional, object) Filters the rules that have a relation with the reference objects with the specific "type" and "ID".
page: (Optional, number) The page number.
per_page: (Optional, number) The number of rules to return per page.
search: (Optional, string) An Elasticsearch simple_query_string query that filters the rules in the response.
search_fields: (Optional, array or string) The fields to perform the simple_query_string parsed query against.
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.

Response codes

edit

200: Indicates a successful call.

Examples

edit

Find rules with names that start with my:

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": "my 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",
        "last_duration": 384
      }
    }
  ]
}

For parameters that accept multiple values (such as fields), repeat the query parameter for each value:

GET api/alerting/rules/_find?fields=id&fields=name

« Enable rule API Get alerting framework health API »