Bulk Get Objects
editBulk Get Objects
editThis functionality is experimental and may be changed or removed completely in a future release.
The bulk-get saved object API enables you to retrieve multiple Kibana saved objects by id.
Request
editPOST /api/saved_objects/_bulk_get
Request Body
editThe request body must be a JSON array containing objects, each of which contains the following properties:
-
type(required) -
(string) Valid options, include:
visualization,dashboard,search,index-pattern,config, andtimelion-sheet -
id(required) - (string) ID of object to retrieve
Response body
editThe response body will have a top level saved_objects property that contains
an array of objects, which 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.
For any saved object that could not be found, an error object will exist in its place.
Examples
editThe following example attempts to retrieve an index pattern with id
my-pattern and a dashboard with id my-dashboard, but only the index pattern
exists.
POST api/saved_objects/_bulk_get
[
{
"type": "index-pattern",
"id": "my-pattern"
},
{
"type": "dashboard",
"id": "my-dashboard"
}
]
A successful call returns a response code of 200 and a response body
containing a JSON structure similar to the following example:
{
"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"
}
}
]
}