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!

Your Feedback. Our Roadmap. Visit the PX Feedback Booth at .conf26

You use Splunk every day, come and help shape what's next.  Save Your Seat: Product-Focused Sessions at ...

Agentic SOC Triage: Investigating Splunk ES Notables with MCP Server and a Local LLM

The Problem: Too Many Alerts, Too Little Context Security operations teams running Splunk Enterprise Security ...

Painting a Clearer Picture: Creating Cross-Domain Visibility with AI Canvas

Watch Now Painting a Clearer Picture: Creating Cross-Domain Visibility with AI Canvas     Do you ever feel ...