Retrieve sets of saved objects that you want to import into Kibana. You must include type or objects in the request body. The output of exporting saved objects must be treated as opaque. Tampering with exported data risks introducing unspecified errors and data loss.
Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
Note
The exported saved objects include coreMigrationVersion and typeMigrationVersion metadata. If you store exported saved objects outside of Kibana (for example in NDJSON files) or generate them yourself, you must preserve or include these fields to retain forward compatibility across Kibana versions.
Note
The savedObjects.maxImportExportSize configuration setting limits the number of saved objects which may be exported.
Do not add export details entry at the end of the stream.
hasReferenceunionanyOf
objectorobject[]
idstring · max length: 512required
typestring · max length: 256required
includeReferencesDeepboolean · default: false
Includes all of the referenced objects in the exported objects.
objectsobject[] · max items: 10000
A list of objects to export. NOTE: this optional parameter cannot be combined with the types option
idstring · max length: 512required
typestring · max length: 256required
searchstring · max length: 10000
Search for documents to export using the Elasticsearch Simple Query String syntax.
typeunionstring | string[]
The saved object types to include in the export. Use * to export all the types. Valid options depend on enabled plugins, but may include visualization, dashboard, search, index-pattern, tag, config, config-global, lens, map, event-annotation-group, query, url, action, alert, alerting_rule_template, apm-indices, cases-user-actions, cases, cases-comments, infrastructure-monitoring-log-view, ml-trained-model, osquery-saved-query, osquery-pack, osquery-pack-asset.