IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Bulk get objects API Create saved objects API »
Elastic Docs ›Kibana Guide [7.7] ›REST API ›Saved objects APIs

Find objects API

edit

Find 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

edit

GET <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) The field that sorts the response.
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 type saved object. It should look like that savedObjectType.attributes.title: "myTitle". However, If you used a direct attribute of a saved object like updatedAt, you will have to define your filter like that savedObjectType.updatedAt > 2018-12-22.

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

edit

Find index patterns 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
« Bulk get objects API Create saved objects API »