topic How to call custom rest api with SplunkJS SDK in app? in Splunk Dev

How to call custom rest api with SplunkJS SDK in app?

datphamtat — Tue, 05 Apr 2022 15:33:40 GMT

I'm developing a new app with react js and SplunkJS SDK.

In my app, I want to call a custom endpoint service that locates in the same app with a URL

https://x.x.x.x:8089/servicesNS/-/<my-app>/run

In my call, I'm trying to call a custom endpoint:

handleSplunkConnect(event) { let http = new splunk_js_sdk.SplunkWebHttp(); return new splunk_js_sdk.Service( http, application_name_space, ); } makeCloudFlareAction(event){ let service = this.handleSplunkConnect() //make splunk service connect let params = { "customer": "JAUC-011", } service.post("/servicesNS/-/<my-app>/run", params, function(err, resp) { console.log(resp) console.log(err) });

But I see the URL request is `https://x.x.x.x:8000/en-US/splunkd/__raw/servicesNS/-/<my-app>/run?output_mode=json` instead of `https://x.x.x.x:8089/servicesNS/-/<my-app>/run?output_mode=json`

My question is how can I call a custom endpoint service with Splunk:8089 by using SplunkJS SDK?
OR, Can I call a custom endpoint service with port 8080 (web) instead of 8089 (splunkd) ?

Re: How to call custom rest api with SplunkJS SDK in app?

datphamtat — Wed, 06 Apr 2022 02:10:33 GMT

I found the solution, two things need to know in here:

For the first one, we can call a custom service endpoint with a proxy, in this case, the proxy is Splunk web (splunk-server:8000). It means you can call

https://x.x.x.x:8000/en-US/splunkd/__raw/services/api-path

Replace for rest endpoint

https://x.x.x.x:8089/servicesNS/-/<my-app>/api-path

The second one, use the request function instead of the post function in SPlunkJS SDK for more customize.

https://docs.splunk.com/DocumentationStatic/JavaScriptSDK/1.0/splunkjs.Service.html#splunkjs.Service^request

My sample code:

service.request("/services/my-api-path","POST", {}, {}, JSON.stringify(params), {'Content-Type': 'application/json'}, function(err, resp) { // Handle response if(resp != null){ if(resp.status == 200){ //do something } else { //do something with status !=200 } } // Handle error if(err != null){ //handle error } });

Re: How to call custom rest api with SplunkJS SDK in app?

37dmk — Thu, 21 Apr 2022 08:34:19 GMT

Thank you very much for the support. This helped me to figure out how to send a request from the frontend to the backend, without specifying the CSRF-token but rather using the splunk_js_sdk to do that for me.

I ended up with following function, to add to my api.js file.

May be someone out there will appreciate the Copy-Pasta.