Bulk get objects API

[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Retrieve multiple Kibana saved objects by ID.

Request

POST <kibana host>:<port>/api/saved_objects/_bulk_get

POST <kibana host>:<port>/s/<space_id>/api/saved_objects/_bulk_get

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.

Request Body

type

(Required, string) Valid options include visualization, dashboard, search, index-pattern, config, and timelion-sheet.

id

(Required, string) ID of the retrieved object. The ID includes the Kibana unique identifier or a custom identifier.

fields

(Optional, array) The fields to return in the attributes key of the object response.

Response body

saved_objects

(array) Top-level property containing objects that represent the response for each of the requested objects. The order of the objects in the response is identical to the order of the objects in the request.

Saved objects that are unable to persist are replaced with an error object.

Response code

200

Indicates a successful call.

Example

Retrieve an index pattern with the my-pattern ID, and a dashboard with the my-dashboard ID:

  1. $ curl -X POST api/saved_objects/_bulk_get
  2. [
  3.   {
  4.     "type": "index-pattern",
  5.     "id": "my-pattern"
  6.   },
  7.   {
  8.     "type": "dashboard",
  9.     "id": "be3733a0-9efe-11e7-acb3-3dab96693fab"
  10.   }
  11. ]

The API returns the following:

  1. {
  2.   "saved_objects": [
  3.     {
  4.       "id": "my-pattern",
  5.       "type": "index-pattern",
  6.       "version": 1,
  7.       "attributes": {
  8.         "title": "my-pattern-*"
  9.       }
  10.     },
  11.     {
  12.       "id": "my-dashboard",
  13.       "type": "dashboard",
  14.       "error": {
  15.         "statusCode": 404,
  16.         "message": "Not found"
  17.       }
  18.     }
  19.   ]
  20. }

Only the index pattern exists.

Most Popular