Splunk Dev

How to read Ajax passed JSON object in Python?

kasu_praveen
Communicator

Hi,

How to read Ajax passed JSON object in .py file? Below are my code snippets from Splunk view, web.conf and .py file.
Looking for code snippet in How to read Ajax passed JSON object here????? section of my .py file

JavaScript:

var dataVal = {'JSONObjKey': JSONObject,'SimpleString': 'String1'};
var JsonData = JSON.stringify(dataVal);
function callScript(){
             $.ajax({
                   type: "POST",
                   url: "/custom/MyApp/my_script/my_endpoint",
                   data: JsonData,
                   contentType: "application/json; charset=utf-8",
                   dataType: "json",
                   success: function(data) {
                       console.log("success returned");
                       console.log(data);
                   },
                   error: function(xhr){
            console.log("Error");
                }
             });
         }        
         callScript();

web.conf

[endpoint:my_script]

my_script.py

import logging
import cherrypy
import splunk.appserver.mrsparkle.controllers as controllers
from splunk.appserver.mrsparkle.lib.util import make_splunkhome_path
from splunk.appserver.mrsparkle.lib.decorators import expose_page

 _APPNAME = 'MyApp'
 def setup_logger(level):
  logger = logging.getLogger('splunk.appserver.%s.controllers.my_script' % _APPNAME)
  logger.propagate = False  # Prevent the log messages from being duplicated in the python.log file
  logger.setLevel(level)
  file_handler = logging.handlers.RotatingFileHandler(
      make_splunkhome_path(['var', 'log', 'splunk', 'my_script_controller.log']), maxBytes=25000000, backupCount=5)
  formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
  file_handler.setFormatter(formatter)
  logger.addHandler(file_handler)
  return logger
 logger = setup_logger(logging.DEBUG)

 class my_script(controllers.BaseController):
  @expose_page(must_login=True, methods=['POST'])
  def my_endpoint(self, **kwargs):
   cherrypy.response.headers['Content-Type'] = 'application/json'
 <<<<<<How to read ajax passed JSON object here?????>>>>>>>
 <<<<<<kwargs['JSONObjKey'] doesn't work here>>>>>>>
   return "Return JSON Object data here????"
0 Karma

jkat54
SplunkTrust
SplunkTrust

in python you will want to import json for handling json.

Here's how to use the json library: https://docs.python.org/2/library/json.html

I would not use cherrypy here though. cherrypy is deprecated in Splunk.

GIve this a read: https://conf.splunk.com/files/2016/slides/extending-splunks-rest-api-for-fun-and-profit.pdf

and refer to the github link at the end of the presentation for sample code.

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!

Splunk Asynchronous Forwarding Explained

Splunk asynchronous forwarding is often misunderstood as simply setting autoLBVolume. That is not quite right. ...

55 Days to Go: Secure Your Seat at Splunk University in Denver

Your .conf26 Experience Starts Before Opening Keynote  If Denver is known for its mile-high elevation, Splunk ...

(re)Introducing the Splunk Community Champions + 2026 – 2027 Splunk MVPs ...

This program exists as a channel to empower and recognize Splunk advocates and help supercharge initiatives to ...