GET <kibana host>:<port>/s/<space_id>/api/saved_objects/_find
Path parameters
space_id
(Optional, string) An identifier for the space. If space_id
is not provided in the URL, the default space is used.
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, 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.
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
200
Indicates a successful call.
Find index patterns with titles that start with my
:
The API returns the following: