kibana/docs/api/dashboard/export-dashboard.asciidoc
Kaarina Tungseth 09934d6645
[DOCS] API intro (#47164) (#48460)
* [DOCS] API intro

* Logstash configuration management

* Reformatting

* Comments from Josh

* Commets from Gail

* Fixed broken things
2019-10-16 16:01:18 -05:00

42 lines
No EOL
1.1 KiB
Text

[[dashboard-api-export]]
=== Export dashboard API
++++
<titleabbrev>Export dashboard</titleabbrev>
++++
experimental[] Export dashboards and corresponding saved objects.
[[dashboard-api-export-request]]
==== Request
`GET /api/kibana/dashboards/export`
[[dashboard-api-export-params]]
==== Query parameters
`dashboard`::
(Required, array|string) The IDs of the dashboards that you want to export.
[[dashboard-api-export-response-body]]
==== Response body
`objects`::
(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>>.
[[dashboard-api-export-codes]]
==== Response code
`200`::
Indicates a successful call.
[float]
[[dashboard-api-export-example]]
==== Example
[source,js]
--------------------------------------------------
GET api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c <1>
--------------------------------------------------
// KIBANA
<1> The dashboard ID is `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c`.