Skip to content

[7.2] Fix export saved objects API docs (#37991) #38097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikecote merged 1 commit into from
Jun 5, 2019
Merged

[7.2] Fix export saved objects API docs (#37991) #38097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions docs/api/saved-objects/export.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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