All Apps and Add-ons

How can I create a setup page for a custom app?

Splunk Employee
Splunk Employee

Working by examples of Windows and Unix apps I'm trying to build a setup page for my app. It has a scripted input for which I would like to configure some parameters using the setup screen like in the aforementioned apps.

I figured that setup.xml file that defines contents of the setup screen would require an EAI endpoint. So I tried to create one inside my app. For this I've put this stanza in restmap.conf:

handleractions=list, edit

and also created inside bin directory:

import splunk.admin as admin

class MyAppConfig(admin.MConfigHandler):
    def setup(self):
        if self.requestedAction == admin.ACTION_EDIT:
            for arg in ['enabled', 'pollInterval']:

    def handleList(self, confInfo):
        confInfo['1'].append('asd', 'zxc')
        confInfo['1'].append('bbb', 'aaa')
        confInfo['2'].append('asd', 'zxc')
        confInfo['2'].append('bbb', 'aaa')

    def handleEdit(self, confInfo):
        name =
        args = self.callerArgs
        # to be completed

# initialize the handler, and add the actions it supports.    
admin.init(MyAppConfig, admin.CONTEXT_NONE)

But going to https://localhost:8089/services/admin/myappconf returned me 404..

Are the EAI endpoints restricted from being defined inside custom apps? If so, is it still possible to create a setup page somehow?

Tags (3)
1 Solution

Splunk Employee
Splunk Employee

that config is valid - are you sure your app is enabled?

View solution in original post

Splunk Employee
Splunk Employee

that config is valid - are you sure your app is enabled?

Splunk Employee
Splunk Employee

Yes, the app was disabled. I changed in app.conf: state = enabled and now I can access my endpoint. Also one needs to make sure splunk is restarted after config changes are made.

0 Karma
Get Updates on the Splunk Community!

March Community Office Hours Security Series Uncovered!

Hello Splunk Community! In March, Splunk Community Office Hours spotlighted our fabulous Splunk Threat ...

Stay Connected: Your Guide to April Tech Talks, Office Hours, and Webinars!

Take a look below to explore our upcoming Community Office Hours, Tech Talks, and Webinars in April. This post ...

Want to Reduce Costs, Mitigate Risk, Improve Performance, or Increase Efficiencies? ...

Splunk Lantern is Splunk’s customer success center that provides advice from Splunk experts on valuable data ...