saved objects

Search for saved objects

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/saved_objects/_find</span></div>

Refer to Spaces for more information.

WARNING: This API is deprecated. This is a legacy Saved Objects API and may be removed in a future version of Kibana.

Searches for Kibana saved objects.

For transferring or backing up saved objects, prefer the export API (POST /api/saved_objects/_export).

get/api/saved_objects/_find

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/saved_objects/_find
  • Auth
    • API key in header Authorization
    • or HTTP basic

Query parameters

per_pagenumber

The number of items per page.

pagenumber

The page index to return.

typestring[] required

The saved object type or types to search for. Use multiple type values to search across types.

searchstring

A text search string.

default_search_operator'OR' | 'AND'

The boolean operator to use when combining multiple values.

search_fieldsstring[]

The fields to search on.

sort_fieldstring

The field to sort on.

OR

Return only saved objects that have a reference to the specified saved object(s).

has_reference_operator'OR' | 'AND'

The boolean operator to use when combining multiple values.

OR

Return only saved objects that do not have a reference to the specified saved object(s).

has_no_reference_operator'OR' | 'AND'

The boolean operator to use when combining multiple values.

fieldsstring[]

The fields to return for each saved object.

filterstring

A KQL filter to apply to the search.

aggsstring

Aggregations as a JSON string.

namespacesstring[]

The namespaces (spaces) to search in.

Response

A search response.

Changes

No operation changes recorded.