icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.
Log4Shell Vulnerability: Information and guidance for you. Get resources.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Sonrai Security Add-on For Splunk
SHA256 checksum (sonrai-security-add-on-for-splunk_100.tgz) b1184e70ec84bfb8877279a72ced024f26ff2b0d6394de642f4407915b55d70e
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate


Sonrai Security Add-on For Splunk

Splunk Cloud
Collects data from Sonrai Security API.

This is an add-on powered by the Splunk Add-on Builder.

Sonrai Security Add-on For Splunk


  • The Sonrai Security Add-on For Splunk pulls Tickets data from the Sonrai platform.
  • Author - Sonrai Security, Inc.

Compatibility Matrix

  • Splunk version: 8.1.x and 8.2.x
  • Python version: Python3
  • OS Support: Linux (Centos) and Windows
  • Browser Support: Chrome and Firefox


Version: 1.0.0

  • Added data collection for Tickets data.
  • Added feature of workflow-actions on tickets events.



Sonrai Security Add-on For Splunk can be installed through UI as shown below. Alternatively, .tar or .spl file can also be extracted directly into $SPLUNK_HOME/etc/apps/ folder.

  1. Log in to Splunk Web and navigate to Apps > Manage Apps.
  2. Click Install app from file.
  3. Click Choose file and select the TA-Sonrai installation file.
  4. Click on Upload.
  5. Restart Splunk if prompted.


This Add-On can be set up in two ways:

  • Standalone Mode: Install the Add-on app on a single machine. This single machine would serve as a Search Head + Indexer + Heavy forwarder for this setup.
  • Distributed Environment: Install Add-on on search head and Heavy forwarder (for REST API).
    • Add-on resides on search head machine need not require any configuration here.
    • Add-on needs to be installed and configured on the Heavy forwarder system.
    • Execute the following command on Heavy forwarder to forward the collected data to the indexer. $SPLUNK_HOME add forward-server <indexer_ip_address>:9997
    • On the Indexer machine, enable event listening on port 9997 (recommended by Splunk).
    • Add-on needs to be installed on search head for CIM mapping

NOTE : For the distributed environment, only indexes of the Forwarder would be shown in the input configuration page.


Configure Sonrai Security Add-on For Splunk:

Add-on Setup

  1. Configure the account from which the data needs to be collected. Detailed steps and information for Account Configuration can be found in Account section. Users can configure Sonrai Account for collecting data from Sonrai Platform:
  2. Users can also configure settings corresponding to the Proxy or Logging in their respective sections.


To configure the Account and Proxy,

  1. Navigate to the Setup-> Configuration.
  2. Provide your Sonrai credentials and click on Add.
Sonrai Account Parameters Mandatory or Optional Description
Account name Mandatory Name of the account
Sonrai Organization ID Mandatory Endpoint Organization ID of users Sonrai account
Sonrai Token Mandatory Token generated on Sonrai Portal. Provided token should be of 30 days lifetime.
Sonrai Host Optional Sonrai Platform hostname to pull the events.


To configure the Proxy,

  1. Navigate to the Setup-> Configuration.
  2. Click on the Proxy tab.
  3. Provide your Proxy credentials and click on Save.
Proxy Parameters Mandatory or Optional Description
Enable Optional To enable or disable the proxy
Proxy Type Mandatory Select proxy type that you want to use from the dropdown (supports HTTP/SOCK4/SOCK5)
Proxy Host Mandatory Host or IP of the proxy server
Proxy Port Mandatory Port for proxy server
Proxy Username Optional Username of the proxy server
Proxy Password Optional Password of the proxy server


To configure the Logging,

  1. Navigate to the Setup-> Configuration.
  2. Click on the Logging tab.
  3. Select the log level from the dropdown and click on Save.


To configure the Inputs,

  1. Navigate to the Setup-> Inputs.
  2. Click on Create New Input, window will open for configuring Sonrai Tickets Input.
  3. Provide the required information related to input and click on Add to configure the input. Field descriptions are as below:

Sonrai Tickets Input

Input Parameter Mandatory or Optional Desciption
Name Mandatory A name to uniquely identify the input
Interval Mandatory Interval should be in range 1200 to 7200
Index Mandatory Index in which the data needs to be ingested
Sonrai Account Mandatory Select Sonrai account for the given Input
Severity Category Optional Select Category for which data needs to be ingested
Environment Optional Select environment value for which data needs to be ingested
Cloud Type Optional Select cloud type value for which data needs to be ingested
Swimlane Optional Select swimlane value for which data needs to be ingested
Start DateTime Optional Select UTC Start DateTime from which data needs to be fetched from sonrai portal

NOTE : If multiple inputs are created with overlapping configurations, there will be duplicate Events in Splunk.


  • To see ingested data for Sonrai Tickets Input, select the Search tab. Search index=* sourcetype="sonrai:sec:tickets".

Workflow Actions

User can explore the ticket on Sonrai platform by using the workflow action provided, user can click on "Redirect to Sonrai Ticket" present under Event Actions.


  • Remove $SPLUNK_HOME/etc/apps/TA-Sonrai.
  • Remove $SPLUNK_HOME/var/log/splunk/ta_sonrai_.log*.
  • To reflect the cleanup changes in UI, Restart Splunk Enterprise instance.


General Checks

  • To troubleshoot Sonrai Security Add-on For Splunk, check $SPLUNK_HOME/var/log/splunk/ta_sonrai*.log or user can search index="_internal" source=*ta_sonrai*.log query to see all the logs in UI. Also, user can use index="_internal" source=*ta_sonrai*.log ERROR query to see ERROR logs in the Splunk UI.
  • Note that all log files of this App will be generated in $SPLUNK_HOME/var/log/splunk/ directory.

Data Collection

  • If data collection is not working then ensure that the internet is active (On a proxy machine, if proxy is enabled) and also ensure that the kvstore is enabled.
  • Check ta_sonrai_sonrai_tickets_input.log file for Sonrai Tickets for any relevant error messages.
  • If user encounters the following error Unable to renew Sonrai token then update the sonrai account credentials on the account configuration page.

    NOTE : Provided token should be of 30 days lifetime.


End User Licence Agreement:



Copyright (C) Sonraí Security 2022.

Release Notes

Version 1.0.0
May 11, 2022

Version: 1.0.0

  • Added data collection for Tickets data.
  • Added feature of workflow-actions on tickets events.

Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.