- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.12
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Cases settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Set up
- Get started
- How-to guides
- Configure APM agents with central config
- Control access to APM data
- Create an alert
- Create custom links
- Filter data
- Find transaction latency and failure correlations
- Identify deployment details for APM agents
- Integrate with machine learning
- Exploring mobile sessions with Discover
- Viewing sessions with Discover
- Observe Lambda functions
- Query your data
- Storage Explorer
- Track deployments with annotations
- Users and privileges
- Settings
- REST API
- Troubleshooting
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Get all data views
- Get data view
- Create data view
- Update data view
- Delete data view
- Swap references preview
- Swap references
- Get default data view
- Set default data view
- Update data view fields metadata
- Get runtime field
- Create runtime field
- Upsert runtime field
- Update runtime field
- Delete runtime field
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Add comment
- Create case
- Delete cases
- Delete comments
- Find case activity
- Find cases
- Find connectors
- Get alerts
- Get case activity
- Get case
- Get case status
- Get cases by alert
- Get comments
- Get configuration
- Get reporters
- Get tags
- Push case
- Set configuration
- Update cases
- Update comment
- Update configuration
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Osquery manager API
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Synthetics APIs
- Uptime APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Kibana 8.12.2
- Kibana 8.12.1
- Kibana 8.12.0
- Kibana 8.11.4
- Kibana 8.11.3
- Kibana 8.11.2
- Kibana 8.11.1
- Kibana 8.11.0
- Kibana 8.10.4
- Kibana 8.10.3
- Kibana 8.10.2
- Kibana 8.10.1
- Kibana 8.10.0
- Kibana 8.9.2
- Kibana 8.9.1
- Kibana 8.9.0
- Kibana 8.8.2
- Kibana 8.8.1
- Kibana 8.8.0
- Kibana 8.7.1
- Kibana 8.7.0
- Kibana 8.6.1
- Kibana 8.6.0
- Kibana 8.5.2
- Kibana 8.5.1
- Kibana 8.5.0
- Kibana 8.4.3
- Kibana 8.4.2
- Kibana 8.4.1
- Kibana 8.4.0
- Kibana 8.3.3
- Kibana 8.3.2
- Kibana 8.3.1
- Kibana 8.3.0
- Kibana 8.2.3
- Kibana 8.2.2
- Kibana 8.2.1
- Kibana 8.2.0
- Kibana 8.1.3
- Kibana 8.1.2
- Kibana 8.1.1
- Kibana 8.1.0
- Kibana 8.0.0
- Kibana 8.0.0-rc2
- Kibana 8.0.0-rc1
- Kibana 8.0.0-beta1
- Kibana 8.0.0-alpha2
- Kibana 8.0.0-alpha1
- Developer guide
Find rules API
editFind rules API
editRetrieve a paginated set of rules based on condition.
For the most up-to-date API details, refer to the open API specification.
Request
editGET <kibana host>:<port>/api/alerting/rules/_find
GET <kibana host>:<port>/s/<space_id>/api/alerting/rules/_find
Prerequisites
editYou 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
editAs 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 asupdatedAt
, 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
ordesc
.
Response codes
edit-
200
- Indicates a successful call.
Examples
editFind rules with names that start with my
:
GET api/alerting/rules/_find?search_fields=name&search=my*
The API returns the following:
{ "page": 1, "total": 1, "per_page": 10, "data": [{ "id": "b530fed0-74f5-11ed-9801-35303b735aef", "name": "cluster_health_rule", "consumer": "alerts", "enabled": true, "tags": ["cluster","health"], "throttle": null, "schedule": {"interval":"1m"}, "params": {}, "rule_type_id": "monitoring_alert_cluster_health", "created_by": "elastic", "updated_by": "elastic", "created_at": "2022-12-05T23:36:58.284Z", "updated_at": "2022-12-05T23:36:58.284Z", "api_key_owner": "elastic", "notify_when": "onActiveAlert", "mute_all": false, "muted_alert_ids": [], "scheduled_task_id": "b530fed0-74f5-11ed-9801-35303b735aef", "execution_status": { "status": "ok", "last_execution_date": "2022-12-06T00:09:31.882Z", "last_duration": 42 }, "actions": [{ "group": "default", "id": "9dca3e00-74f5-11ed-9801-35303b735aef", "params": { "level": "info", "message": "{{context.internalFullMessage}}" }, "connector_type_id": ".server-log" }], "last_run":{ "alerts_count": {"new": 0,"ignored": 0,"recovered": 0,"active": 0}, "outcome_msg": null, "warning": null, "outcome": "succeeded" }, "next_run": "2022-12-06T00:10:31.811Z" }] }
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