Splunk Dev

Manipulate conf file through Splunk/Rest API

klausJohan
Path Finder

Hi,

Is there any experience around to be shared concerning how to programmatically manipulate (read, update) through Splunk API or REST API a custom conf file (say "myapp.conf").

Cheers

1 Solution

sowings
Splunk Employee
Splunk Employee

I'd start with trying the | rest search command in Splunk. It would at least tell you if your custom config file is reachable by the REST endpoint. Try: | rest /services/configs/conf-myapp (or optionally, constrain the app and user: | rest /servicesNS/admin/myapp/configs/conf-myapp).

Note that any POSTs to define settings don't have restrictions on the keys, that's up to your app to define. More docs about the POST (and an example) can be found here:

http://docs.splunk.com/Documentation/Splunk/6.0/RESTAPI/RESTconfig

View solution in original post

sowings
Splunk Employee
Splunk Employee

I'd start with trying the | rest search command in Splunk. It would at least tell you if your custom config file is reachable by the REST endpoint. Try: | rest /services/configs/conf-myapp (or optionally, constrain the app and user: | rest /servicesNS/admin/myapp/configs/conf-myapp).

Note that any POSTs to define settings don't have restrictions on the keys, that's up to your app to define. More docs about the POST (and an example) can be found here:

http://docs.splunk.com/Documentation/Splunk/6.0/RESTAPI/RESTconfig

klausJohan
Path Finder

Eventually it worked with curl also.

0 Karma

sowings
Splunk Employee
Splunk Employee

How did you issue the curl call?

I created a new config 'myconfig' and a corresponding 'myconfig.conf.spec' in the README subdir of my app. After that, I was able to

curl -k -u admin:pass https://127.0.0.1:8089/servicesNS/admin/fire_brigade/configs/conf-myconfig

I only mention the README subdir because I didn't try it without. Did you get an error from the curl call? I got an XML response that contained the config key. Note also that I restarted Splunk after adding the config file and the README/myconfig.conf.spec. I'm not sure if that was required, but....

0 Karma

klausJohan
Path Finder

Yes, through "| rest ..." I can see my conf file. But the get/post request with curl or from the browser return no result

0 Karma
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!

May 2026 Splunk Expert Sessions: Security & Observability

Level Up Your Operations: May 2026 Splunk Expert Sessions Whether you are refining your security posture or ...

Network to App: Observability Unlocked [May & June Series]

In today’s digital landscape, your environment is no longer confined to the data center. It spans complex ...

SPL2 Deep Dives, AppDynamics Integrations, SAML Made Simple and Much More on Splunk ...

Splunk Lantern is Splunk’s customer success center that provides practical guidance from Splunk experts on key ...