Export objects APIedit

[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 sets of saved objects that you want to import into Kibana.

Requestedit

POST /api/saved_objects/_export

Request bodyedit

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.
excludeExportDetails
(Optional, boolean) Do not add export details entry at the end of the stream.

You must include type or objects in the request body.

Response bodyedit

The format of the response body is newline delimited JSON. Each exported object is exported as a valid JSON record and separated by the newline character \n.

When excludeExportDetails=false (the default) we append an export result details record at the end of the file after all the saved object records. The export result details object has the following format:

{
  "exportedCount": 27,
  "missingRefCount": 2,
  "missingReferences": [
    { "id": "an-id", "type": "visualisation"},
    { "id": "another-id", "type": "index-pattern"}
  ]
}

Response codeedit

200
Indicates a successful call.

Examplesedit

Export all index pattern saved objects:

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

Export all index pattern saved objects and exclude the export summary from the stream:

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

Export a specific saved object:

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

Export a specific saved object and it’s related objects :

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