Export 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 a set of saved objects that you want to import into Kibana.

Request

POST /api/saved_objects/_export

Request body

type
(Optional, array|string) The saved object types to include in the export.
objects
(Optional, array) A list of objects to export.
includeReferencesDeep
(Optional, boolean) Includes all of the referenced objects in the exported objects.

You must include type or objects in the request body.

Response body

The format of the response body includes newline delimited JSON.

Response code

200
Indicates a successful call.

Examples

Export all index pattern saved objects:

POST api/saved_objects/_export
{
  "type": "index-pattern"
}

Export a specific saved object:

POST api/saved_objects/_export
{
  "objects": [
    {
      "type": "dashboard",
      "id": "be3733a0-9efe-11e7-acb3-3dab96693fab"
    }
  ]
}