maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix export saved objects API docs (#37991)

Browse source
This commit is contained in:
Mike Côté 2019-06-05 07:47:21 -04:00 committed by GitHub
parent 4a3034de49
commit 9772ab5cd8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/api/saved-objects/export.asciidoc
View file

@ -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