- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.4
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners 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
- 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
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- 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
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
Find objects API
editFind objects API
edit[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Retrieve a paginated set of Kibana saved objects by various conditions.
Request
editGET <kibana host>:<port>/api/saved_objects/_find
GET <kibana host>:<port>/s/<space_id>/api/saved_objects/_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-
type
- (Required, array|string) The saved object types to include in the export.
-
per_page
- (Optional, number) The number of objects to return per page.
-
page
- (Optional, number) The page of objects to return.
-
search
- (Optional, string) An Elasticsearch simple_query_string query that filters the objects in the response.
-
default_search_operator
-
(Optional, string) The default operator to use for the
simple_query_string
. -
search_fields
-
(Optional, array|string) The fields to perform the
simple_query_string
parsed query against. -
fields
-
(Optional, array|string) The fields to return in the
attributes
key of the response. -
sort_field
-
(Optional, string) Sorts the response. Includes "root" and "type" fields. "root" fields exist for all saved objects, such as "updated_at".
"type" fields are specific to an object type, such as fields returned in the
attributes
key of the response. When a single type is defined in thetype
parameter, the "root" and "type" fields are allowed, and validity checks are made in that order. When multiple types are defined in thetype
parameter, only "root" fields are allowed. -
has_reference
- (Optional, object) Filters to objects that have a relationship with the type and ID combination.
-
filter
-
(Optional, string) The filter is a KQL string with the caveat that if you filter with an attribute from your saved object type,
it should look like that:
savedObjectType.attributes.title: "myTitle"
. However, If you use a root attribute of a saved object such asupdated_at
, you will have to define your filter like that:savedObjectType.updated_at > 2018-12-22
. -
aggs
-
(Optional, string) experimental An aggregation structure, serialized as a string. The field format is similar to
filter
, meaning that to use a saved object type attribute in the aggregation, thesavedObjectType.attributes.title
: "myTitle"` format must be used. For root fields, the syntax issavedObjectType.rootField
As objects 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.
Response code
edit-
200
- Indicates a successful call.
Examples
editFind data views with titles that start with my
:
$ curl -X GET api/saved_objects/_find?type=index-pattern&search_fields=title&search=my*
The API returns the following:
{ "total": 1, "data": [ { "id": "my-pattern", "type": "index-pattern", "version": 1, "attributes": { "title": "my-pattern-*" } } ] }
For parameters that accept multiple values (e.g. fields
), repeat the
query parameter for each value:
$ curl -X GET api/saved_objects/_find?fields=id&fields=title