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 JupiterOne Add-on for Splunk
SHA256 checksum (jupiterone-add-on-for-splunk_130.tgz) 74814a8199a889cf33f9ac08525cca95ae71561f172925195f0c2ca05e3c30df SHA256 checksum (jupiterone-add-on-for-splunk_120.tgz) 98811eccc9343fea94726bde1b52399428e237c866378b1c4bff0e7560d35c2d SHA256 checksum (jupiterone-add-on-for-splunk_110.tgz) 4f1afd26f5d4cecaff388da69eeb4d01329f64c120b621901698b03d35b14c64 SHA256 checksum (jupiterone-add-on-for-splunk_100.tgz) a43f4e0a3dcbb58aaa8fe1366f620f4fa90917197ae74765599f9437d164c498
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

JupiterOne Add-on for Splunk

Splunk Cloud
Overview
Details
The JupiterOne Add-on imports and enriches JupiterOne Alerts, allowing you to access this data in Splunk. It collects alert data directly from JupiterOne, parses the data and extracts valuable data so that you can trigger your own notable alerts in your Splunk account.

It also provides workflow actions that allow you to link back to entities in JupiterOne or search your JupiterOne account for any field value in Splunk, regardless of entitytype and now supports a Custom Command so that you can execute a J1QL query directly from Splunk and display the response from JupiterOne in your Splunk account.

JupiterOne Add-on for Splunk

OVERVIEW

  • The Add-on typically imports and enriches data from JupiterOne platform, creating a rich data set ready for direct analysis or use in an App. The JupiterOne Add-on for Splunk will provide the below functionalities:

    • Collects data from the REST endpoint of the JupiterOne platform.
    • Parse the data and extract important fields.
    • Adds a workflow action for JupiterOne entities
    • Adds a workflow action for any field value in Splunk
    • Includes a Custom Command (jupiteronesearch) to execute a J1QL query on JupiterOne Platform and display the response in Splunk.
  • Author - JupiterOne, Inc.

  • Version - 1.3.0

COMPATIBILITY MATRIX

  • Browser: Google Chrome, Mozilla Firefox
  • OS: Platform Independent
  • Splunk Enterprise version: 8.0.X, 8.1.X, 8.2.X
  • Supported Splunk Deployment: Splunk Cluster, Splunk Standalone, and Distributed Deployment

RELEASE NOTES

Version 1.3.0

  • Added Custom Command (jupiteronesearch) to execute a J1QL query on JupiterOne Platform and display the response in Splunk.

Version 1.2.0

  • Added workflow action to search field value of the entities on the JupiterOne platform.
  • Updated the TA logo.

Version 1.1.0

  • Added checkbox on inputs page to indicate whether to collect alert related entities or not.
  • Added data collection logic to collect entities associated with the alert.
  • Added workflow action to explore more details of alert-related entities on the JupiterOne platform.

Version 1.0.0

  • Added support for data collection of JupiterOne Alerts.
  • Added correlation search to create notable events of JupiterOne Alerts.

RECOMMENDED SYSTEM CONFIGURATION

TOPOLOGY AND SETTING UP SPLUNK ENVIRONMENT

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

1) 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.
2) 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.
    /opt/splunk/bin/splunk 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.

INSTALLATION

Follow the below-listed steps to install an Add-on from the bundle:

  • Download the App package.
  • From the UI navigate to Apps-> Manage Apps.
  • In the top right corner select Install the app from file.
  • Select Choose File and select the App package.
  • Select Upload and follow the prompts.

OR

  • Directly from the Find More Apps section provided in Splunk Home Dashboard.

CONFIGURATION

1. Add JupiterOne Credentials

To generate the JupiterOne API key, open JupiterOne platform and navigate to Settings -> Users & Access page. Thereafter click on API Keys to generate new key. Thereafter, click on NEW API KEY button and enter "Key name and Days before expiration". Thereafter click on CREATE button. Thereafter on Splunk instance, navigate to JupiterOne Add-on for Splunk, click on Configuration -> JupiterOne Account tab and click on Add, fill in the details asked and click "Save". Field descriptions are as below:

Field Name Field Description
Account Name* Unique name for account
Account Id* JupiterOne account Id
API Key* JupiterOne API key

Note: * denotes required fields

2. Configure Proxy (Optional)

Navigate to JupiterOne Add-on for Splunk -> Configuration -> Proxy tab, fill in the details asked and click "Save". Field descriptions are as below:

Field Name Field Description
Enable Enable/Disable proxy
Proxy Type* Type of proxy
Host* Hostname/IP Address of the proxy
Port* Port of proxy
Username Username for proxy authentication (Username and Password are inclusive fields)
Password Password for proxy authentication (Username and Password are inclusive fields)

Note: * denotes required fields

3. Configure Logging (Optional)

Navigate to JupiterOne Add-on for Splunk -> Configuration -> Logging tab, select the prefered "Log level" value from the dropdown and click "Save".

4. Create Data Input

Navigate to JupiterOne Add-on for Splunk -> Inputs. Click on "Create New Input". Fill in the details asked and click "Add". Field descriptions are as below:

JupiterOne Alerts Input

Field Name Field Description
Name* Unique name for the data input
Interval* Time interval of input in seconds
Index* Index where data will be stored
JupiterOne Account* Account that you have configured in "Configuration" tab
Pull Alert Related Objects Checkbox to pull alert related objects or not
Start Date Date in UTC from when to start collecting data. Default will be last 30 days

Note: * denotes required fields

5. Configure number of threads (Optional)

  • After upgrade from v1.0.0 to 1.1.0 or any higher version, If a user wants to configure the number of threads to collect alert-related entities then follow the below steps otherwise it will be half of the CPU count.
    • Place the stanza at $SPLUNK_HOME/etc/apps/TA-JupiterOne/local/ta_jupiterone_settings.conf as mentioned below:
      [threads] no_of_threads = <Specify the no. of threads to collect alert related entities>

UPGRADE

From v1.0.0 to v1.X.X

Follow the below steps to upgrade the Add-on

  • Disable all the inputs from the Inputs page of JupiterOne Add-on for Splunk.
  • Install the JupiterOne Add-on for Splunk.
  • Restart the Splunk if required and if prompted by Splunk.
  • Navigate to the JupiterOne Add-on for Splunk.
  • From the Inputs page, enable the already created inputs or click on "Create New Input" to create new input with required fields.

Correlation SavedSearch

  • "Threat - JupiterOne Alerts - Rule" : This savedsearch is used to create notable events.
  • Note: If you want to add custom field on incident review, then visit the following link :
    Adding custom field on incident review page

WorkFlow Actions

JupiterOne: Explore Entity on J1 Portal

  • The app provides a workflow action "JupiterOne: Explore Entity on J1 Portal" for event type "jupiterone_alert_entities" to explore details about a specific entity on JupiterOne Platform.

JupiterOne: Search Field on J1 Portal

  • The app provides a workflow action "JupiterOne: Search Field on J1 Portal" for any event type to search field values of the entities on JupiterOne Platform.

NOTE: If the user wants to use host value other than "apps.us.jupiterone.io" then user needs to manually configure the workflow action as mentioned below:

  • Go to settings > Fields > Workflow actions.
  • In App filter select the "JupiterOne Add-on for Splunk" and select the "JupiterOne: Search Field on J1 Portal" workflow action.
  • In the "URI" field, replace the "apps.us.jupiterone.io" with the host of the JupiterOne portal.
  • Click on the save button.

TROUBLESHOOTING

If Data is not getting collected in Splunk

  • Check $SPLUNK_HOME/var/log/splunk/splunkd.log and $SPLUNK_HOME/var/log/splunk/ta_jupiterone_*.log log files.
  • Check that you have selected correct sourcetype.
  • Make sure that API Key which you have entered while configuring Account is not expired.
  • Make sure that splunk restart or disabling of input action should not be performed while input (data collection) is running.

Note: $SPLUNK_HOME denotes the path where Splunk is installed. Ex: /opt/splunk

If not able to collect alert related entities for existing inputs after upgradation from V1.0.0 to V1.1.0 or any higher version

  • The user needs to create new input or clone that input by checking the "Pull Alert Related Objects" checkbox.

UNINSTALL ADD-ON

To uninstall the add-on, the user can follow the below steps: SSH to the Splunk instance -> Go to folder apps($SPLUNK_HOME/etc/apps) -> Remove the TA-JupiterOne folder from apps directory -> Restart Splunk.

END USER LICENSE AGREEMENT

https://jupiterone.com/terms/

SUPPORT

BINARY FILE DECLARATION

Copyright 2022 JupiterOne, Inc.

Release Notes

Version 1.3.0
March 14, 2022

Version 1.3.0

  • Added Custom Command (jupiteronesearch) to execute a J1QL query on JupiterOne Platform and display the response in Splunk.
Version 1.2.0
Dec. 21, 2021

JupiterOne Add-on for Splunk

OVERVIEW

  • The Add-on typically imports and enriches data from JupiterOne platform, creating a rich data set ready for direct analysis or use in an App. The JupiterOne Add-on for Splunk will provide the below functionalities:

    • Collects data from the REST endpoint of the JupiterOne platform.
    • Parse the data and extract important fields.
  • Author - JupiterOne, Inc.

  • Version - 1.2.0

COMPATIBILITY MATRIX

  • Browser: Google Chrome, Mozilla Firefox
  • OS: Platform Independent
  • Splunk Enterprise version: 8.0.X, 8.1.X, 8.2.X
  • Supported Splunk Deployment: Splunk Cluster, Splunk Standalone, and Distributed Deployment

RELEASE NOTES

Version 1.2.0

  • Added workflow action to search field value of the entities on the JupiterOne platform.
  • Updated the TA logo.

Version 1.1.0

  • Added checkbox on inputs page to indicate whether to collect alert related entities or not.
  • Added data collection logic to collect entities associated with the alert.
  • Added workflow
Version 1.1.0
Dec. 1, 2021

Version 1.1.0

  • Added checkbox on inputs page to indicate whether to collect alert related entities or not.
  • Added data collection logic to collect entities associated with the alert.
  • Added workflow action to explore more details of alert-related entities on the JupiterOne platform.
Version 1.0.0
Oct. 14, 2021

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.