Kibana import/export dashboard api

tsullivan93 · November 17, 2017, 5:47pm

Is there any documentation on how to use the new import/export dashboard api for kibana?

chrisronline · November 17, 2017, 6:04pm

Hi @tsullivan93,

I'm not sure what you're referring to. Do you have a link available that talks about this new api?

Thanks,
Chris

tsullivan93 · November 17, 2017, 6:20pm

Hi Chris!

I've seen it mentioned a couple places. This PR

github.com/elastic/kibana

Import / Export API for Dashboards

elastic:master ← simianhacker:import-export

opened 10:05PM - 22 Mar 17 UTC

simianhacker

+906 -17

This PR creates an import / export API for dashboards. The current implementatio…n under `Mangement > Saved Objects` allows you to only export `everything` or individual dashboards (with out the supporting saved objects like searches, visualizations or index patterns). This creates 2 API endpoints at `/api/kibana/dashboards/export` and `/api/kibana/dashboards/import`. The user can POST to the export end point an array of dashboard IDs. The response will contain ALL (searches, index patterns, visualizations, etc) the objects needed for that dashboard in an object with a version. To import a dashboard (an all of it's supporting objects) the user can POST the same object returned from the export endpoint to the import endpoint. The import endpoint will check the version and try and upgrade the objects if they are from a previous version; and import them into the `.kibana` index; skipping existing objects.

and in the metricbeat dashboard documentation for how it imports its dashboards it mentions

Starting with Beats 6.0.0, the dashboards are loaded via the Kibana API

chrisronline · November 17, 2017, 6:30pm

Hi @tsullivan93,

Unfortunately, I don't think there any official docs for that feature yet. The PR description talks about both endpoints with some degree of specificity and there might be comments in the PR that detail them more.

If you have any specific questions about it, I can try and help with that too.

Thanks,
Chris

tsullivan93 · November 17, 2017, 6:48pm

Essentially what I would like to be able to do is build a dashboard in kibana, export the dashboard I built and get the json object for it so I can use that as a template for future metricbeat installs via the import api that metricbeat uses

chrisronline · November 17, 2017, 7:05pm

Hitting <kibana>/api/kibana/dashboards/export?dashboard=<dashboard_id> returns the same structure as the dashboards from metricbeat. I think should work for you.

If you want to do multiple, <kibana>/api/kibana/dashboards/export?dashboard=<dashboard_id>&dashboard=<dashboard_id>

Lemme know if that helps!

tsullivan93 · November 17, 2017, 7:20pm

That was exactly what I needed! Thanks Chris!

system · December 15, 2017, 7:20pm

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.