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

« Delete object API Import objects API »

› › ›

Export objects API

edit

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

Request

edit

POST /api/saved_objects/_export

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

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: (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

edit

The format of the response body includes newline delimited JSON.

Response code

edit

200: Indicates a successful call.

Examples

edit

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"
    }
  ]
}

« Delete object API Import objects API »