Dashboards & Visualizations

Modify dashboard using REST API

neptoon
Engager

I'd like to modify a dashboard's content using the REST API (for example add another report or an HTML panel). Is there a proper way to do it?

I found out that I can get the dashboard information and source by issuing a GET request to https://$server$:8089/servicesNS/$user$/$app$/data/ui/views/$dashboardName$

I tried to POST to the same URI with a "data=..." request body, containing the dashboard source, but I get an error:

In handler 'views': Argument " Average usage </searchName> <option name" is not supported by this handler.

Tags (2)
0 Karma

chujun1990
Engager

Hi, i believe you might have included {name: 'your_dashboard_name'} in the data your are posting.
For creating new dashboard, you need:
1. URL: https://$server$:8089/servicesNS/$user$/$app$/data/ui/views/
(Notice that please don't include the dashboard name in the url)
2. data {'name': 'dashboard_name', 'eai:data': 'dashboard_xml_definition'}

For updating existing dashboard, you need:
1. URL: https://$server$:8089/servicesNS/$user$/$app$/data/ui/views/$dashboardName$
(Notice that please include the dashboard name)
2. data {'eai:data': 'dashboard_xml_definition'}
(Notice that don't include the name param)

Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

Event Series: Telemetry Pipeline Management

Balancing Scale and Spend: Gaining Control Over High-Volume Metrics in Splunk Observability Cloud As ...

Kick the Tires Before You Commit: A Hands-On Tour of the Splunk Observability Cloud ...

Evaluating an enterprise observability platform usually goes like this: fill out a form, get a free trial with ...

Deep insights, no barriers: Splunk Observability Cloud Free Edition

As software delivery cycles continue to accelerate, observability shouldn’t be a luxury — it should be a ...