From 9772ab5cd8ebee6954524763dc0c336a110160a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mike=20C=C3=B4t=C3=A9?= Date: Wed, 5 Jun 2019 07:47:21 -0400 Subject: [PATCH] Fix export saved objects API docs (#37991) --- docs/api/saved-objects/export.asciidoc | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/api/saved-objects/export.asciidoc b/docs/api/saved-objects/export.asciidoc index 9c757c31bc17..4cda4dd6278d 100644 --- a/docs/api/saved-objects/export.asciidoc +++ b/docs/api/saved-objects/export.asciidoc @@ -16,7 +16,7 @@ Note: You cannot access this endpoint via the Console in Kibana. (array|string) The saved object type(s) that the export should be limited to `objects` (optional):: (array) A list of objects to export -`includeReferencesDeep`:: +`includeReferencesDeep` (optional):: (boolean) This will make the exported objects include all the referenced objects needed Note: At least `type` or `objects` must be passed in. @@ -33,9 +33,25 @@ The following example exports all index pattern saved objects. -------------------------------------------------- POST api/saved_objects/_export { - "type": "index-patterns" + "type": "index-pattern" } -------------------------------------------------- // KIBANA A successful call returns a response code of `200` along with the exported objects as the response body. + +The following example exports specific saved objects. + +[source,js] +-------------------------------------------------- +POST api/saved_objects/_export +{ + "objects": [ + { + "type": "dashboard", + "id": "be3733a0-9efe-11e7-acb3-3dab96693fab" + } + ] +} +-------------------------------------------------- +// KIBANA \ No newline at end of file