topic Re: Is the REST API incomplete with respect to Deployment steps in Getting Data In

Is the REST API incomplete with respect to Deployment steps

perichandra — Thu, 18 Jul 2013 07:06:26 GMT

I went through the Splunk REST API documentation at http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI/RESTdeploy
and am unable to find the APIs that would cover all the steps needed to remotely carry out the deployment process. While I find the APIS to create higher level entities such as deployment servers/clients and server classes and to propagate manually created configs, I see no APIs for lower level details such as creating the config details for inputs and forwarders under particular server classes.

I would appreciate it if anyone could confirm that it is indeed so, if not, where the API is for doing them.

If the Splunk REST API is indeed incomplete in those respects, how do large Splunk farms manage deployment processes? They log in to master deployment servers and manually create configs on the masters and propagate them? Or is there an App to do these?
Thanks.

Re: Is the REST API incomplete with respect to Deployment steps

sowings — Thu, 18 Jul 2013 11:53:40 GMT

For a quick answer about how this is managed, yes, it's typical to log in to the deployment manager and modify serverclass.conf directly.

The configs portion of the API works directly on the apps in $SPLUNK_HOME/etc/apps, not the deployment-apps hierarchy used (by default) on the deployment manager. At present, I'm not aware of any Splunkbase apps or other UI to make the process of creating the deployment-apps any easier.

Re: Is the REST API incomplete with respect to Deployment steps

monzy — Fri, 19 Jul 2013 23:37:33 GMT

is it possible for you to modify config files using the REST API steps documented here:
http://docs.splunk.com/Documentation/Splunk/5.0.3/RESTAPI/RESTconfigurations

Re: Is the REST API incomplete with respect to Deployment steps

perichandra — Mon, 22 Jul 2013 13:01:11 GMT

Hi Sowings
What do you think of the answer by Monzy below pointing to http://docs.splunk.com/Documentation/Splunk/5.0.3/RESTAPI/RESTconfigurations?

It appears to control only the configs of local Splunk server not the configs being prepared for remote deployment.

Re: Is the REST API incomplete with respect to Deployment steps

tulakayre — Mon, 10 Nov 2014 07:58:00 GMT

Is there any REST API method available NOW for -- create deployment-apps
Splunk version 6.1.3

Re: Is the REST API incomplete with respect to Deployment steps

jaxjohnny2000 — Fri, 04 Jan 2019 14:06:59 GMT

There is not, even now in version 7.2.1, a way to fully manage the Deployment server or deployment-apps or even compare conf files from one deployment app to another.

Re: Is the REST API incomplete with respect to Deployment steps

jkat54 — Fri, 04 Jan 2019 14:10:49 GMT

Install Telerik’s fiddler, enable ssl decryption, do everything you want to do in your question/use case while recording the traffic, then use the recorded steps to see which API calls with which headers and payloads, etc were sent to complete each task.

The WebUI is all just pretty js, pictures and buttons that create the rest calls you’ll see in fiddler.

Re: Is the REST API incomplete with respect to Deployment steps

jkat54 — Fri, 04 Jan 2019 14:13:24 GMT

Tip, DS reloads after every change to apps/classes in the UI