2019-09-06 18:09:57 +02:00
[[dashboard-api-export]]
=== Export dashboard API
++++
2019-10-16 22:10:40 +02:00
<titleabbrev>Export dashboard</titleabbrev>
2019-09-06 18:09:57 +02:00
++++
2018-09-07 21:52:08 +02:00
2019-09-18 17:54:28 +02:00
experimental[] Export dashboards and corresponding saved objects.
2018-12-05 22:20:58 +01:00
2019-09-06 18:09:57 +02:00
[[dashboard-api-export-request]]
2018-09-07 21:52:08 +02:00
==== Request
2020-03-20 22:33:20 +01:00
`GET <kibana host>:<port>/api/kibana/dashboards/export`
2018-09-07 21:52:08 +02:00
2020-10-21 09:20:54 +02:00
`GET <kibana host>:<port>/s/<space-id>/api/kibana/dashboards/export`
2019-09-06 18:09:57 +02:00
[[dashboard-api-export-params]]
==== Query parameters
2018-09-07 21:52:08 +02:00
2019-09-06 18:09:57 +02:00
`dashboard`::
(Required, array|string) The IDs of the dashboards that you want to export.
2018-09-07 21:52:08 +02:00
2019-09-06 18:09:57 +02:00
[[dashboard-api-export-response-body]]
2018-09-07 21:52:08 +02:00
==== Response body
2020-03-20 22:33:20 +01:00
`objects`::
2019-10-16 22:10:40 +02:00
(array) A top level property that includes the saved objects. The order of the objects is not guaranteed. Use the exact response body as the request body for the corresponding <<dashboard-import-api, Import dashboard API>>.
2020-03-20 22:33:20 +01:00
2019-09-06 18:09:57 +02:00
[[dashboard-api-export-codes]]
==== Response code
2018-09-07 21:52:08 +02:00
2019-09-06 18:09:57 +02:00
`200`::
Indicates a successful call.
2018-09-07 21:52:08 +02:00
2019-09-06 18:09:57 +02:00
[float]
[[dashboard-api-export-example]]
==== Example
2018-09-07 21:52:08 +02:00
2020-03-20 22:33:20 +01:00
[source,sh]
2018-09-07 21:52:08 +02:00
--------------------------------------------------
2020-07-14 21:59:21 +02:00
$ curl -X GET api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c <1>
2018-09-07 21:52:08 +02:00
--------------------------------------------------
// KIBANA
2020-03-20 22:33:20 +01:00
<1> The dashboard ID is `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c`.