topic Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources? in Dashboards & Visualizations

Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

w22chaudh — Thu, 04 Dec 2014 21:21:56 GMT

Hi,

I'm trying to automate restoring splunk dashboards from their xml source. I've found the xml sources for my dashboards in
$SPLUNK_HOME/etc/apps/search/local/data/ui/views. I'd like to keep a copy of these in git and have a script that would utilize the splunk REST API or Javascript SDK to populate the dashboards into my splunk using the xml sources. So my question is if the splunk API or Javascript SDK allows for this?

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

martin_mueller — Thu, 04 Dec 2014 22:52:01 GMT

Yes.

The relevant REST endpoint is /servicesNS/user_name/app_name/data/ui/views/view_name, but I'm afraid its docs are missing from docs.splunk.com/Documentation/Splunk/6.2.0/RESTREF/RESTknowledge so you'd have to go and guess/reverse-engineer the correct parameters. Do submit feedback at the bottom of that page to let the docs team know.

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

amrit — Mon, 28 Sep 2020 19:25:12 GMT

Martin's right. Per the special auto-doccing URL /servicesNS/user_name/app_name/data/ui/views/_new , the required parameters are eai:data and the implicit name. You can accomplish a Create by POSTing to views/my_view_name and specifying the raw XML content in the eai:data parameter.

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

deanilol — Fri, 03 Apr 2015 09:59:07 GMT

I'm looking for the same thing. Let's say I wan't to change the XML source, how could my cURL command look like?

Thanks!

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

martin_mueller — Sat, 04 Apr 2015 21:56:37 GMT

Say you have a dashboard called curl owned by admin privately in the search app. Then you can run this to overwrite its XML:

$ curl -k -u admin:changeme https://localhost:8089/servicesNS/admin/search/data/ui/views/curl -d "eai:data=<dashboard><label>weeee</label></dashboard>"

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

deanilol — Sun, 05 Apr 2015 11:26:06 GMT

awesome answer!

how could the cURL command look if I want to create a new dashboard using POST. Tried to do it the way Amrit tells it but I get "argument is not supported by this handler".

This would help me alot!!

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

martin_mueller — Sun, 05 Apr 2015 17:20:50 GMT

Like this:

$ curl -k -u admin:changeme https://localhost:8089/servicesNS/admin/search/data/ui/views -d "name=foo&eai:data=<dashboard><label>weeee</label></dashboard>"

Creating a knowledge object always is a POST to the root of the knowledge object with a name passed as a parameter, modifying is a POST to that knowledge object itself with the name in the path.

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

frobinson_splun — Fri, 09 Oct 2015 00:16:23 GMT

Thank you, @martin_mueller and @amrit, for your discussion of these endpoints. FYI, there is now documentation for /views and /views/{name} here:
http://docs.splunk.com/Documentation/Splunk/6.3.0/RESTREF/RESTknowledge#data.2Fui.2Fviews

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

vamsy7 — Tue, 29 Sep 2020 09:55:33 GMT

Hi. Is there any way to retrieve the data from dashboard using REST API.
/servicesNS/user_name/app_name/data/ui/views/view_name, this URL will give us the info about the dashboard.
i want the data to be pulled from dashboard.

Re: Can you use the Splunk REST API or Javascript SDK to create dashboards in Splunk using the XML sources?

martin_mueller — Wed, 17 Aug 2016 19:50:23 GMT

You should ask a separate question, @vamsy7.