Add an image

Add custom images to your dashboard for visual branding, illustrative context, and dashboard backgrounds. You can reference an image by URL or upload images to the key value store (KV store), where the images are accessible to all members of an organization.

Upload an image

All uploaded images in the KV store, including those in private dashboards, are accessible to all members of an organization.

When you upload an image, it is stored in the KV store. Because of this, only Enterprise admins, Cloud sc_admins, and power users can upload or delete images. If you don't have the correct role assigned to upload images, you can ask someone with the correct role to add it for you. The following formats are supported for uploading an image:

• png
• jpeg
• gif
• webp

Reference an image by URL

Users with any permission set or role can add an image to their dashboard by referencing a URL. You can reference a local image or link to an image URL using the absolute layout. You cannot add an image if you are using the grid layout.

Relative image URL

PNG and PDF exports include images referenced by a relative URL. To use a relative URL, you must know the exact directory path of your image and use that path to build the relative URL.

The following is an example of the steps you might take when using a relative image URL.

1. Upload your image. Your file path on disk might look like the following:
   $SPLUNK_HOME/etc/apps/<myapp>/appserver/static/images/<myfile.png>
2. Select the Add Image button ( ) in the editing toolbar.
3. Add the image's relative URL to your dashboard. The relative URL is the file path on the server. Your relative URL might look like the following:
   /static/app/<myapp>/images/<myfile.png>

Relative image URL examples

/static/app/splunk-dashboard-studio/images/examples-hub/datacenter/Background_v2.png

/static/app/splunk-dashboard-studio/images/examples-hub/images/splunk_logo.png

External image URL

PNG and PDF exports cannot download images referenced by an external URL. To ensure these images render in a PNG or PDF export, save them to a local directory and upload them to your dashboard, if you have the correct permissions. The following is an example of an external URL.

https://www.buttercup-games.com/image.png

Add an external URL to the dashboards image allow list

The dashboards image allow list is a list of authorized URL domains that aids the management of external images. Images without a domain specified in the list do not render in the dashboard. To permit an external image, you can add the image's URL domain to the list.

For more Splunk Cloud Platform related details, see Configure dashboards image allow list and Content Security Policy setting in the Splunk Cloud Platform Admin Manual.

For Splunk Enterprise dashboards, you can add external URLs to the dashboards_csp_allowed_domains setting and set enforce_dashboards_csp to True in your web.conf file.

Add an image to your dashboard

1. Select the Add Image button ( ) in the editing toolbar.
2. Add an image using one of the following methods:
• Enter a URL for your image in the Enter URL field.
• Drag and drop a local image.
• Select browse... and navigate to your image.

Images might take a while to render. The current size limit to upload an image to the KV store is 16MB.

Configuration Panel options for images

Position & Size
You can use your mouse to change the size or location of the visualization, or the Position & Size section of the Configuration panel for pixel perfect sizing and placement.

Drilldown
Specify a URL to go to when a user clicks the image.

Source options for images

The following options are available for editing an image in the source editor:

Property	Type	Default	Description
src	string	N/A	URL of an image file. The editor accepts all browser-supported image formats.
preserveAspectRatio	boolean	false	Set to true to maintain the aspect ratio of an image when the screen is resized.