JDBC Driver for Splunk

Build 23.0.8839

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Splunk consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.splunk.SplunkDriver
  • Provide the JDBC URL. For example:
    jdbc:splunk:user=MyUserName;password=MyPassword;URL=MyURL;
    
    or
    
    jdbc:cdata:splunk:user=MyUserName;password=MyPassword;URL=MyURL;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:splunk:" or "jdbc:cdata:splunk:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Splunk APIs

You must specify the URL to a valid Splunk server. By default the driver makes requests on port 8089.

By default, the driver attempts to negotiate TLS/SSL with the server. For more information on TLS/SSL configuration, see SSL Configuration.

Authenticating to Splunk

There are two ways to authenticate to Splunk data: logging in with Splunk credentials, or using a Splunk authentication token.

Splunk Credentials

To authenticate with Splunk credentials, set User and Password to your login credentials.

Splunk Token

When you access Splunk via an authentication token, you can access the Splunk platform using Representational State Transfer (REST) calls. On Splunk Enterprise, you can also use the CLI. Both of these methods enable you to access the instance and make requests without having to authenticate via credentials.

Note: Unless you are accessing a search head cluster (where you can use the same token to access all available head clusters), you must have a separate token for each instance being accessed.

To authenticate with a Splunk token:

  1. In the Splunk UI, navigate to Users and Authentication > Tokens to access your assigned authentication token. If you do not have one, request one from the administrator of the instance you want to access.
  2. Set the AuthScheme to AccessToken; and the AccessToken property to your Splunk token.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839