icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.
Log4Shell Vulnerability: Information and guidance for you. Get resources.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Search Head Backup
SHA256 checksum (search-head-backup_010.tgz) c104651bfaf45e5786e306f0e3ff464b5a1eae3edb93898baff8857c51f7c5ae
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate


Search Head Backup

Splunk Cloud
Ever wanted a simple way to backup your dashboards and knowledge objects in Splunk Cloud, well that is what this is.

There are other really powerful solutions that backup to Git repositories using a self-managed Heavy Forwarder, but I wanted a simpler solution that was fully self contained in Splunk Cloud.

Search Head Backup runs a scheduled search locally on the Search Head and stores your dashboards and knowledge objects to a Splunk index daily, allowing you to manually restore any of these to any point in time based on the index retention period. The specific objects collected is configurable using a lookup table.

If you are on Splunk Classic, raise a support request to get this installed on your ES and ITSI Search Heads to back them up too!

Installation Instructions

Install the app on all desired Search Heads (support case required for ES and ITSI on Splunk Cloud Classic).

Then open the app, and click Setup in the navigation bar. Each panel represents a configuration you should change.

Set both the index and host macros, then enable the scheduled search. You can optionally edit the REST endpoints that are backed up.

Technical Overview

All this App does is run the following scheduled search daily. It provides a dashboard to help understand whats being backed up.

| rest splunk_server=local /services/apps/local count=0 search=visible=1
| eval x=1, host=coalesce(`search_head_backup_host`,splunk_server)
| fields title host x
| join max=0 x [| inputlookup search_head_backup_targets.csv | eval x=1]
| eval uri="/servicesNS/nobody/".title."/".target
| map search="| rest splunk_server=local $uri$ count=0 search=eai:acl.app=$title$ | eval label=\"$label$\" | tojson | fields _raw
| collect index=`search_head_backup_index` host=$host$ sourcetype=json_no_timestamp source=$uri$" maxsearches=1000

Release Notes

Version 0.1.0
May 16, 2022

Initial Release

Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.