Splunk Dev

Java SDK connect with sessionKey

lweber
Path Finder

Hi

because it took me a while to figure out, I'll post the question and give the answer myself...

Using the documentation I did not figure out how I can connect to Splunk using a session key (eg. passed from a python script via passAuth).

The documentation is showing an example using the Service.login(...) and the Service.setToken(String token)method, the latter was used for a base64 encripted username:password token.

answer will follow in a second...

0 Karma
1 Solution

lweber
Path Finder

it's simple as this 😉

Service.setToken("Splunk sessionKey")

btw:
in the example: http://dev.splunk.com/view/java-sdk/SP-CAAAECX you're using com.sun.org.apache.xerces.internal.impl.dv.util.Base64 to encode the user:password token. It is always a bad (!) idea to use code placed in class placed in a internalpackage.
Use: java.util.Base64 instead.

View solution in original post

0 Karma

mishiehow
Explorer

The session key gets added in a cookie which browser uses on the subsequent search call.

0 Karma

npbala_22
Explorer

How to get sessionKey for particular splunk db

0 Karma

lweber
Path Finder

depends where you want to use it.

  • in plain Java you need to login first. Service.getToken, you can use the sessionkey from you browser session, but it will expire.
  • if you java code gets called from a REST endpoint (python) which extends splunk.rest.BaseRestHandler you already have it in your class (self.sessionKey).
0 Karma

sathishraja92
Explorer

can you share the piece of your code which uses the Splunk session key to connect and create/poll/consume the search !

0 Karma

lweber
Path Finder

the sdk is quite well documented. have a look at: http://dev.splunk.com/java and the examples.
the setToken method is docmentented here: http://docs.splunk.com/DocumentationStatic/JavaSDK/1.6.4/com/splunk/ServiceArgs.html#setToken-java.l...

0 Karma

sathishraja92
Explorer

Thanks. It worked

0 Karma

lweber
Path Finder

it's simple as this 😉

Service.setToken("Splunk sessionKey")

btw:
in the example: http://dev.splunk.com/view/java-sdk/SP-CAAAECX you're using com.sun.org.apache.xerces.internal.impl.dv.util.Base64 to encode the user:password token. It is always a bad (!) idea to use code placed in class placed in a internalpackage.
Use: java.util.Base64 instead.

0 Karma
Get Updates on the Splunk Community!

Splunk Observability Cloud’s AI Assistant in Action Series: Analyzing and ...

This is the second post in our Splunk Observability Cloud’s AI Assistant in Action series, in which we look at ...

Elevate Your Organization with Splunk’s Next Platform Evolution

 Thursday, July 10, 2025  |  11AM PDT / 2PM EDT Whether you're managing complex deployments or looking to ...

Splunk Answers Content Calendar, June Edition

Get ready for this week’s post dedicated to Splunk Dashboards! We're celebrating the power of community by ...