2018-09-07 21:52:08 +02:00
|
|
|
[[dashboard-import-api-export]]
|
|
|
|
|
=== Export Dashboard
|
|
|
|
|
|
|
|
|
|
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
|
|
|
|
|
|
|
|
|
The dashboard export API allows people to export dashboards along with all of
|
|
|
|
|
their corresponding saved objects such as visualizations, saved searches, and
|
|
|
|
|
index patterns.
|
|
|
|
|
|
|
|
|
|
==== Request
|
|
|
|
|
|
|
|
|
|
`GET /api/kibana/dashboards/export`
|
|
|
|
|
|
|
|
|
|
==== Query Parameters
|
|
|
|
|
|
2018-11-06 09:59:59 +01:00
|
|
|
`dashboard` (required)::
|
2018-09-07 21:52:08 +02:00
|
|
|
(array|string) The id(s) of the dashboard(s) to export
|
|
|
|
|
|
|
|
|
|
==== Response body
|
|
|
|
|
|
|
|
|
|
The response body will have a top level `objects` property that contains an
|
|
|
|
|
array of saved objects. The order of these objects is not guaranteed. You
|
|
|
|
|
should use this exact response body as the request body for the corresponding
|
|
|
|
|
<<dashboard-import-api-import, Import Dashboard API>>.
|
|
|
|
|
|
|
|
|
|
==== Examples
|
|
|
|
|
|
|
|
|
|
The following example exports all saved objects associated with and including
|
|
|
|
|
the dashboard with id `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c`.
|
|
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
GET api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
// KIBANA
|
|
|
|
|
|
|
|
|
|
A successful call returns a response code of `200` along with the exported
|
|
|
|
|
objects as the response body.
|
