topic Re: Is it possible to set a custom HTTP response header from a custom API endpoint? in Getting Data In

Is it possible to set a custom HTTP response header from a custom API endpoint?

plambert — Sat, 04 Feb 2017 01:35:41 GMT

Given a Splunk Enterprise instance, we'd like to implement a custom API handler that also sets the CORS headers in the response:

Access-Control-Allow-Origin: http://…
Access-Control-Allow-Credentials: true

The goal is to allow a cloud service, with a customer's consent as expressed by installing the custom application AND providing the URL for their Splunk Enterprise instance, to perform a specific search via the custom REST API endpoint handler.

Before we start to dig into it, is there anything in place to prevent or disallow this? Has anyone done this and have any tips?

Re: Is it possible to set a custom HTTP response header from a custom API endpoint?

arkadyz1 — Fri, 21 Apr 2017 19:38:33 GMT

I've done it and did set at least Access-Control-Allow-Origin with no problem.

Re: Is it possible to set a custom HTTP response header from a custom API endpoint?

paramagurukarth — Mon, 24 Apr 2017 12:23:57 GMT

The doc to implement custom end points in splunk is available here,
Just python implementation..

It internally uses cherrypy, you can set header by

cherrypy.response.headers['Content-Type'] = 'application/json'

Re: Is it possible to set a custom HTTP response header from a custom API endpoint?

marcolesh — Fri, 18 May 2018 17:31:52 GMT

Could you give and example, I can´t figure it out. I'm getting No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost:8000' is therefore not allowed access.

Re: Is it possible to set a custom HTTP response header from a custom API endpoint?

arkadyz1 — Mon, 21 May 2018 13:33:22 GMT

How is your API organized? It can be added in more than one way: when I wrote my response, we were adding exta REST API endpoints via etc/system/local/restmap.conf - this makes them accessible through the management port (8089 by default). There you just add your header to the response:

class YourOwnAPIHandler(splunk.rest.BaseRestHandler):
    def handle_POST(self):

      ...
      self.response.setHeader('access-control-allow-origin', '*')
      return

The response by paramagurukarthikeyan below shows how to do that in the custom end points created using <your_app>/default/web.conf and appserver/controllers/<your_endpoints>.py

Re: Is it possible to set a custom HTTP response header from a custom API endpoint?

marcolesh — Thu, 31 May 2018 15:41:04 GMT

¡Thank you arkadyz I have succesefully implmented it!
The problem I had was related to CORS.