IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Saved objects APIs Import objects API »
Elastic Docs ›Kibana Guide [8.12] ›REST API ›Saved objects APIs

Export objects API

edit

Export objects API

edit

Retrieve sets of saved objects that you want to import into Kibana.

For the most up-to-date API details, refer to the open API specification.

Request

edit

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

POST <kibana host>:<port>/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. Use * to export all the types.
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.

The savedObjects.maxImportExportSize configuration setting limits the number of saved objects which may be exported.

Response body

edit

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 code

edit
200
Indicates a successful call.

Examples

edit

Export all data view saved objects:

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "type": "index-pattern"
}'

Export all data view saved objects and exclude the export summary from the stream:

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "type": "index-pattern",
  "excludeExportDetails": true
}'

Export a specific saved object:

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "objects": [
    {
      "type": "dashboard",
      "id": "be3733a0-9efe-11e7-acb3-3dab96693fab"
    }
  ]
}'

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

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "objects": [
    {
      "type": "dashboard",
      "id": "be3733a0-9efe-11e7-acb3-3dab96693fab"
    }
  ],
  "includeReferencesDeep": true
}'

Export all exportable saved objects and their related objects:

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "type": "*",
  "includeReferencesDeep": true
}'
« Saved objects APIs Import objects API »