Bulk get objects APIedit

[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. Retrieve multiple Kibana saved objects by ID.

Requestedit

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

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

Path parametersedit

space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

Request Bodyedit

type
(Required, string) Valid options include visualization, dashboard, search, index-pattern, config.
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.
namespaces

(Optional, string array) Identifiers for the spaces in which to search for this object. If this is provided, the object is searched for only in the explicitly defined spaces. If this is not provided, the object is searched for in the current space (default behavior).

  • For shareable object types (registered with namespaceType: 'multiple'): this option can be used to specify one or more spaces, including the "All spaces" identifier ('*').
  • For isolated object types (registered with namespaceType: 'single' or namespaceType: 'multiple-isolated'): this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed.
  • For global object types (registered with namespaceType: 'agnostic'): this option cannot be used.

Response bodyedit

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 codeedit

200
Indicates a successful call. Note, this HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body. See the example below for details.

Exampleedit

Retrieve a data view with the my-pattern ID, and a dashboard with the my-dashboard ID:

$ curl -X 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 data view exists.