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

› › ›

Find Objects

edit

Find Objects

edit

This functionality is experimental and may be changed or removed completely in a future release.

The find saved object API enables you to retrieve a paginated set of Kibana saved objects by various conditions.

Note: You cannot access this endpoint via the Console in Kibana.

Request

edit

GET /api/saved_objects/_find

Query Parameters

edit

type (required): (array|string) The saved object type(s) that the response should be limited to
per_page (optional): (number) The number of objects to return per page
page (optional): (number) The page of objects to return
search (optional): (string) A simple_query_string Elasticsearch query to filter 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 response
sort_field (optional): (string) The field on which the response will be sorted
has_reference (optional): (object) Filters to objects having a relationship with the type and id combination

As objects change in Kibana, the results on each page of this response can change. This makes the find API suitable for traditional paginated results but not a reliable way to safely export large amounts of data.

Examples

edit

The following example attempts to find index patterns with titles that start with my:

GET api/saved_objects/_find?type=index-pattern&search_fields=title&search=my*

A successful call returns a response code of 200 and a response body containing a JSON structure similar to the following example:

{
  "total": 1,
  "data": [
    {
      "id": "my-pattern",
      "type": "index-pattern",
      "version": 1,
      "attributes": {
        "title": "my-pattern-*"
      }
    }
  ]
}

Multiple values for a parameter

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

GET api/saved_objects/_find?fields=id&fields=title

« Bulk Get Objects Create Object »