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

› › ›

Bulk get objects API

edit

Bulk get objects API

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Retrieves multiple Kibana saved objects by ID.

Request

edit

POST /api/saved_objects/_bulk_get

POST /s/<space_id>/api/saved_objects/_bulk_get

Path parameters

edit

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

edit

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

edit

saved_objects: (array) Top-level property the contains 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

edit

200: Indicates a successful call.

Example

edit

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

POST api/saved_objects/_bulk_get
[
  {
    "type": "index-pattern",
    "id": "my-pattern"
  },
  {
    "type": "dashboard",
    "id": "be3733a0-9efe-11e7-acb3-3dab96693fab"
  }
]

The API returns the following:

{
  "saved_objects": [
    {
      "id": "my-pattern",
      "type": "index-pattern",
      "version": 1,
      "attributes": {
        "title": "my-pattern-*"
      }
    },
    {
      "id": "my-dashboard",
      "type": "dashboard",
      "error": {
        "statusCode": 404,
        "message": "Not found"
      }
    }
  ]
}

Only the index pattern exists.

« Get object API Find objects API »