New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Saved Objects API Bulk Get Objects »
Elastic Docs ›Kibana Guide [7.1] ›REST API ›Saved Objects API

Get Object

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get Object

edit

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

The get saved object API enables you to retrieve a single Kibana saved object by id.

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

Request

edit

GET /api/saved_objects/<type>/<id>

Path Parameters

edit
type (required)
(string) Valid options, include: visualization, dashboard, search, index-pattern, config, and timelion-sheet
id (required)
(string) ID of object to retrieve

Examples

edit

The following example retrieves the index pattern object with an id of my-pattern.

GET api/saved_objects/index-pattern/my-pattern
Copy as curl 

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

{
  "id": "my-pattern",
  "type": "index-pattern",
  "version": 1,
  "attributes": {
    "title": "my-pattern-*"
  }
}
« Saved Objects API Bulk Get Objects »

On this page

Was this helpful?
Feedback