> For the complete documentation index, see [llms.txt](https://docs.dropzone.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dropzone.ai/integrations/data/splunk_data.md).

# Splunk

{% hint style="info" %}
Splunk is an SIEM integration. SIEM integrations are used to perform analysis of any SIEM generated alerts, and/or to use generated data as part of investigation analysis.
{% endhint %}

Dropzone AI integrates with the [Splunk](https://www.splunk.com/en_us/products/enterprise-security-essentials.html) security SIEM. Many customers ingest other alert sources into Splunk (e.g. IDPs) and integrate Dropzone into Splunk rather than the source systems.

Dropzone communicates to Splunk Enterprise using the Dropzone Connector.

There are two methods to integrate with Dropzone: creating a Splunk User or configuring an API token. To create an API token, follow instructions in [Splunk's documentation](https://help.splunk.com/en/splunk-cloud-platform/administer/manage-users-and-security/9.3.2411/authenticate-into-the-splunk-platform-with-tokens/set-up-authentication-with-tokens).

## Create a Splunk User

To create a Splunk user, do the following:

* In the Home Menu of Splunk Enterprise, navigate to Settings > Users

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FNoyrtEPK17UZFptAd7XN%2Fsplunk-api-1.png?alt=media" alt=""><figcaption><p>Navigate to Users</p></figcaption></figure>

* Click "New User"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FOFuvrPqYNHXBesm6g87j%2Fsplunk-api-2.png?alt=media" alt=""><figcaption><p>Click New User</p></figcaption></figure>

* Name the user something memorable, such as Dropzone AI, and create a password. Save them for use later in the Dropzone UI where they are called "Username" and "Password" respectively
* In the "Assign Roles" section, assign the user the "User" role

{% hint style="info" %}
You may need to add [capabilities](https://docs.splunk.com/Documentation/Splunk/9.4.2/Security/Rolesandcapabilities) to this role depending on the level of access you want Dropzone to have. If you would like to limit the indexes Dropzone has access to, you will need to create a custom role with inherited permissions from the user role. See the Splunk [documentation](https://docs.splunk.com/Documentation/Splunk/9.4.2/Security/Addandeditroles) for more information on creating custom roles.
{% endhint %}

* If two-factor authentication is enabled, provide the Duo username

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FKRtaNQQSMPDu1luOrSFi%2Fsplunk-api-3.png?alt=media" alt=""><figcaption><p>Fill out fields for New User</p></figcaption></figure>

* Click "Create"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FINNHMJAWlxEIfoZz5X3X%2Fsplunk-api-4.png?alt=media" alt=""><figcaption><p>Create new user</p></figcaption></figure>

## Enable Splunk

To enable the Data Source integration, you'll need the following information:

| Dropzone Field | Source                                                                        |
| -------------- | ----------------------------------------------------------------------------- |
| Server         | The hostname or IP address of your Splunk server, e.g splunk.corp.example.net |
| Password       | The username of the Splunk user you created earlier                           |
| Password       | The password of the Splunk user you created earlier                           |

{% hint style="info" %}
If you chose to create an API token instead of a Splunk user, you will need to use the API token instead.
{% endhint %}

To enable the Data Source integration, do the following:

* Navigate to your Dropzone AI tenant home page e.g. https\://*mycompany*.dropzone.app
* In the left side bar, navigate to Platform Settings > Integrations

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FQKQGU2YK0KqsewZWvh0i%2Fui-integrations-dropdown.png?alt=media" alt=""><figcaption><p>Integrations Dropdown</p></figcaption></figure>

* Click "Library"

{% hint style="info" %}
If you have previously integrated this application, click "Configured"
{% endhint %}

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2Fx4O3FuRG5IqPwx5sFuHr%2Fapp_system_integrations_library.png?alt=media" alt=""><figcaption><p>Click Library</p></figcaption></figure>

* In the Search bar, search Splunk, then click "Configure"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FnhtFIS9iUSFoK0LsaZPh%2Fapp_system_integrations_available_splunk.png?alt=media" alt=""><figcaption><p>The Splunk Tile</p></figcaption></figure>

* Input your Splunk Server and port

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FN0YZuu9Mz5DzkLGduJ54%2Fapp_system_integrations_available_splunk_data_config_1.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 1)</p></figcaption></figure>

* If you created a Splunk User, under "Authentication Method," select Password. If you created an API token, select Token

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FP4gRapiIxcoGQkvoKZgr%2Fapp_system_integrations_available_splunk_data_config_2.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 2)</p></figcaption></figure>

* Input your authentication details

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FwNjENz76e38bvf0bH5A0%2Fapp_system_integrations_available_splunk_data_config_3.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 3)</p></figcaption></figure>

* If you wish for Dropzone to only investigate specific indexes, click "Add Item" in the Index Allow List section. Input the list of Splunk [indexes](https://docs.splunk.com/Documentation/Splunk/9.4.2/Indexer/Aboutindexesandindexers) you want Dropzone to investigate. Otherwise, leave blank

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FggBAaGebuaeIg7P9nl25%2Fapp_system_integrations_available_splunk_data_config_4.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 4)</p></figcaption></figure>

You can configure your integration settings to help manage resource usage and limit overloading your Splunk deployment. Splunk deployments have dedicated limits for scheduled searches and live operations. See [Set limits for concurrent scheduled searches](https://help.splunk.com/en/splunk-cloud-platform/administer/admin-manual/10.1.2507/configure-search-settings-in-splunk-cloud-platform/set-limits-for-concurrent-scheduled-searches) for more information. If you do not know the number of concurrent queries your deployment can support, check [here](https://splunk.my.site.com/customer/s/article/Search-Concurrency-The-maximum-number-of-concurrent-has-been-reached).

* Under "Max Concurrent Queries (Live Operations)", input the maximum number of concurrent queries from Dropzone AI that your Splunk deployment can support
* Under "Max Concurrent Queries (Threat Hunting)" input the percentage of your live operations limit you want to reserve for the Threat Hunting feature. If you don't have Threat Hunting, input 0
* Under "Max Concurrent Queries (Data Scan)" input the number of concurrent Splunk queries you want to set aside for Data scanning

{% hint style="warning" %}
Your Splunk service account's search quota must be higher than these limits combined, and ideally should have a few searches of headroom.
{% endhint %}

* Under "Splunk Time per Question", input the number of seconds to wait when making individual HTTP requests to the Splunk API before timeout
* Under "Splunk Time per Search", input the maximum duration of time a Splunk search should run. Once the limit has been reached, Splunk will stop the search, and Dropzone will use whatever partial results were gotten

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2F09TbmbPzVbeBTzwhhHud%2Fapp_system_integrations_available_splunk_data_config_5.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 5)</p></figcaption></figure>

* If you wish to reduce average scan times in environments with many sourcetypes, check the box labeled "Enable Smart Grouping" to allow Dropzone to automatically group sourcetypes by shared prefixes
* Select the scanner lookback window, e.g. how far back the scanner will query information from. The default is 7 days

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FxVt1EEUrcrdEqAORmscX%2Fapp_system_integrations_available_splunk_data_config_6.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 6)</p></figcaption></figure>

* If you want to further customize Dropzone's query configuration, check the box next to "Enable" in the "Advanced: Query Configuration" section. Then input your desired index selection tips, query tips, query examples, and [macro](https://docs.splunk.com/Documentation/Splunk/9.4.2/Knowledge/Usesearchmacros) configuration

{% hint style="success" %}
Though they are different features, be sure to use the same Best Practices as you do when using the [Query Guidance](https://docs.dropzone.ai/integrations/data) feature.
{% endhint %}

* In the "Enrichment Queries" section, you can help guide Dropzone's AI analyst search queries when looking for information about entities. To do so, click "Add Item." Select the type of entity you want to enrich and input a guiding query. The query must be read-only SPL containing a single entity token

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FS1FIJI87CXpCwY1A8B43%2Fapp_system_integrations_available_splunk_data_config_8.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 8)</p></figcaption></figure>

* If you wish to help guide the AI's information gathering process, enable the [Query Guidance](https://docs.dropzone.ai/integrations/data) feature. Click "Add Item" and input your Condition and Instruction pairs

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FcYfD24VJsFX1ZjoP5UDb%2Fintegration-query-guidance.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 9)</p></figcaption></figure>

* If you have [Splunk MCP](https://help.splunk.com/en/splunk-cloud-platform/mcp-server-for-splunk-platform/2.0/about-mcp-server-for-splunk-platform), you can connect it to your Dropzone Integration. Check the box labeled "Enable", then input an [encrypted authentication token](https://help.splunk.com/en/splunk-cloud-platform/mcp-server-for-splunk-platform/2.1/set-up-and-connect-to-splunk-mcp-server/manage-encrypted-tokens-for-splunk-mcp-server).

{% hint style="info" %}
This feature is under active development. Its functionality may change as it is updated.
{% endhint %}

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FzuE1Z66qOYUAAnJA2u1O%2Fapp_system_integrations_available_splunk_data_config_10.png?alt=media" alt=""><figcaption><p>The Splunk Data Source Configuration (pt 10)</p></figcaption></figure>

* Click "Test & Save" to finish

If you have any errors or questions, contact our Customer Success team.
