Create a setup page for a Splunk app

If your app requires the user to specify configuration settings, create a setup page, which is displayed the first time the user runs the app. Using a setup page is useful when you want to distribute apps to different environments, or to customize an app for a particular usage. For example, collect credentials or proxy settings let users enable a scripted input, or set the frequency and alerting for a report.

Here's an example of a setup page:

Sample setup page

The user can run the setup page again from Splunk Web by clicking the Manage Apps gear icon, then clicking Set up under the Actions column for the app.

The setup page writes changes the user makes to the app's configuration to the $SPLUNK_HOME/etc/apps/your_app_name/local directory. Settings in the /local directory override those in the app's default directory.

To create a setup page, start by creating a setup.xml file in $SPLUNK_HOME/etc/apps/your_app_name/default/:

<setup>
    <block title=" " endpoint=" " entity=" ">
        . . .
    </block>
</setup>

Next, use the Splunk REST API (or custom endpoints) to configure the setup page.

For more information, see the following topics: