
Splunk Cloud SIEM / Vectra integration guide (start here for RUX)
Start here for Splunk Cloud integration with Vectra Respond UX, including supported add-ons/apps, install matrix, API client setup, and data inputs.
Integration Overview
Vectra AI provides add-ons and apps that enable seamless integration with Splunk Cloud Platform and Splunk Enterprise Security. These integrations allow security teams to ingest, analyze, and operationalize Vectra data directly within Splunk workflows.
Vectra provides two primary data sources for Splunk:
Vectra RUX
Vectra RUX uses a patent-pending combination of data science, machine learning and behavioral analysis to reveal the fundamental characteristics of malicious threat behavior. The Vectra platform captures packets and logs across public cloud, SaaS, federated identity and data center networks to surface and prioritize threats. These high-fidelity insights can be pulled via API to integrate seamlessly with your workflows and operations.
Network Metadata from Vectra Stream
Leveraging the same platform, Vectra provides the ability to export network metadata collected by the Vectra Sensors deployed through the environment to Splunk. This data provides an in-depth view of any communication observed in your environment and enables you to perform investigation & threat hunting. A list of protocols supported, and attributes extracted is available here.
Vectra RUX Add-On and Apps for Splunk
Vectra RUX
Vectra RUX uses a patent-pending combination of data science, machine learning, and behavioral analysis to identify the fundamental characteristics of malicious threat behavior. The Vectra platform collects and analyzes packets and logs across public cloud, SaaS, federated identity, and data center environments to surface and prioritize high-fidelity threat detections.
These insights can be retrieved through the Vectra API and integrated into Splunk to support investigation, alert triage, threat hunting, and security operations workflows.
Vectra RUX Technology Add-on
Add-on
10.5, 10.4, 10.3, 10.2, 10.1, 10.0, 9.4, 9.3, 9.2, 9.1
Yes
Yes
Vectra Respond UX
JSON
Vectra RUX App
App
10.5, 10.4, 10.3, 10.2, 10.1, 10.0, 9.4, 9.3, 9.2, 9.1
Yes
Yes
Vectra Respond UX
n/a
Vectra Stream
Vectra Stream enables the export of network metadata collected by Vectra Sensors deployed across the environment. This metadata provides detailed visibility into observed communications, helping security teams perform deeper investigations, threat hunting, and network behavior analysis in Splunk.
Technology Add-on for Vectra Stream (JSON)
Add-on
10.5, 10.4, 10.3, 10.2, 10.1, 10.0, 9.4, 9.3, 9.2, 9.1
Yes
Yes
JSON
N/A
Vectra Stream
App
10.5, 10.4, 10.3, 10.2, 10.1, 10.0, 9.4, 9.3, 9.2, 9.1, 9.0
Yes
Yes
n/a
Installation Matrix
Search Head
Add-on and App
Both must be installed for distributed or standalone Splunk
Indexer
Add-on only
Do not install on Indexer if using Heavy Forwarders
Heavy Forwarder
Add-on only
Must be installed here if using Heavy Forwarders
Universal Forwarder
None
Prerequisites
Before configuring the Vectra AI integration with Splunk Cloud Platform, ensure the following requirements are met:
A valid Splunk account with access to Splunkbase to download the required Vectra apps and add-ons.
A supported version of Splunk Cloud Platform or Splunk Enterprise.
All application dependencies listed in the Add-ons and Apps table are installed and configured.
The required Splunk index or indexes are created before data ingestion begins.
Integration of Splunk Cloud with Vectra RUX
Integrating Splunk Cloud Platform with Vectra RUX involves three main steps:
Creating API clients in the Vectra Respond UX for use by the Technology Add-on.
Installing and configuring the Vectra RUX Technology Add-on.
Installing the Vectra RUX App.
Create API Clients in Vectra Respond UX
API clients must be created in the Vectra Respond UX. These API clients are used by the Vectra RUX Technology Add-on for Splunk to authenticate with the Vectra platform and retrieve data.
Install and Configure the Vectra RUX Technology Add-on
The Vectra RUX Technology Add-on for Splunk collects data from the Vectra platform, including:
Entity scoring data
Detection data
Audit data
Lockdown data
Health data
The Technology Add-on performs CIM mapping for detection and audit data. It also maps entity scoring and detection data fields to the corresponding Vectra Syslog event fields.
1. Creating API Clients for Splunk Integration
Before configuring the Splunk integration, create separate API clients for each endpoint required by the integration.
Creating individual API clients for each endpoint is required to ensure that the Splunk integration can securely and efficiently collect data from Vectra.
Why Separate API Clients Are Required
Separate API clients are required for the following reasons:
Each endpoint used by the Splunk integration is polled individually.
Different endpoints require different permission levels in Vectra.
Using separate API clients helps improve performance and scalability when accessing multiple API endpoints.
Troubleshooting is easier because each API client is associated with a specific endpoint and purpose.
Access can be managed more securely by assigning only the required permissions to each API client.
API Clients Required for the Integration
Create the following API clients for use with the Vectra Splunk integration.
ro_splunk_entity_scoring
Read-only
Used by Splunk to poll the entity_scoring endpoint.
ro_splunk_detections
Read-only
Used by Splunk to poll the detections endpoint.
ro_splunk_lockdown
Read-only
Used by Splunk to poll the lockdown endpoint.
audit_splunk_audits
Auditor
Used by Splunk to poll the audits endpoint.
audit_splunk_health
Auditor
Used by Splunk to poll the health endpoint.
Recommended Naming Convention
Use clear and descriptive API client names so that each client can be easily identified during configuration, maintenance, and troubleshooting.
The recommended naming format is:
<role>_splunk_<endpoint>
For example:
ro_splunk_detections
This naming convention indicates that the API client:
Uses a read-only role.
Is intended for Splunk.
Is associated with the detections endpoint.
Permission Guidance
Assign only the permissions required for each endpoint to follow the principle of least privilege.
Use a Read-only role for endpoints that require only read access.
Use an Auditor role for endpoints that require audit-level access.
Avoid using overly permissive roles unless they are specifically required.
Following these guidelines helps maintain least-privilege access for the Splunk integration and reduces unnecessary permissions.
RUX API Client Creation
To create each of the API clients listed above, follow these steps:
Log in to Vectra Respond UX (RUX).
Navigate to Configuration > API Clients under Access.
Click Add API Client.

Enter a name for the API client, select the appropriate role, and optionally provide a description. Once you have entered the required details, click Generate Credentials.

Save the API Client Credentials
On the API Client Created screen, copy the Client ID and Secret Key and store them in a secure location for later configuration in Splunk. Then, click Done.
Important: The Secret Key is displayed only once and cannot be retrieved later. If you do not copy and securely save the Secret Key at this stage, you must delete the API client and create a new one to obtain a new key.

Once you have created all five required API clients, your screen should look similar to the following:

After Creating the API Clients
After all required API clients have been created:
Securely save the client credentials. Store the Client ID and Secret Key in a secure location for use during the Splunk configuration.
Verify the assigned roles. Confirm that each API client has been assigned the correct role.
Configure the API clients in Splunk. Use the API client credentials when configuring accounts in the Vectra RUX Technology Add-on for Splunk.
Create the account configurations. Create one account configuration in the add-on for each API client.
Continue with the Splunk configuration. Once all API clients are created and verified, proceed with the remaining add-on configuration steps in Splunk.
2. Install and Configure the Vectra RUX Technology Add-on
Install the Add-on in Splunk Cloud
Install the Vectra RUX Technology Add-on for Splunk in your Splunk Cloud Platform environment using one of the supported Splunk Cloud installation methods.
Option 1: Install from Splunkbase in Splunk Cloud (Recommended)
Log in to Splunk Cloud Platform with an account that has the required administrative permissions.
From the Splunk Home page, navigate to Apps > Find More Apps.
Search for Vectra RUX Technology Add-on.
Select the add-on and click Install.
When prompted, enter your Splunk.com credentials and accept the license terms.
After installation completes, verify that the add-on appears under Apps > Manage Apps.
Option 2: Install from an App Package
Download the Vectra RUX Technology Add-on package from Splunkbase.
Log in to Splunk Cloud Platform with the required administrative permissions.
Navigate to Apps > Manage Apps.
Select Install app from file or Upload App, depending on your Splunk Cloud experience.
Click Choose file and select the downloaded add-on package.
Click Upload and follow the prompts.
Wait for Splunk Cloud to validate the app package.
After the package is approved, click Install.
Confirm that the add-on appears under Apps > Manage Apps.
Configure Accounts in the Vectra RUX Technology Add-on
After the Vectra RUX Technology Add-on for Splunk is installed, configure the accounts that the add-on will use to authenticate with the Vectra platform.
In Splunk Cloud Platform, navigate to Apps.
Open Vectra RUX Technology Add-on.
Go to Configuration > Account.
Click Add to create a new account.
Add one account for each API client created earlier in the Vectra Respond UX.
Enter the required connection details, including the Vectra platform URL and the API client credentials.
Save each account configuration.
When complete, the Account page should include separate account entries for each required API client, similar to the following:
splunk_entity_scoring
Polls the entity_scoring endpoint.
ro_splunk_detections
Polls the detections endpoint.
ro_splunk_lockdown
Polls the lockdown endpoint.
audit_splunk_audits
Polls the audits endpoint.
audit_splunk_health
Polls the health endpoint.



2.2 Vectra RUX Technology Add-on: New Installation and Data Input Configuration
After installing the Vectra RUX Technology Add-on and configuring the required Vectra account. It explains how to create data inputs that collect data from the selected Vectra endpoints. Create a separate data input for each account and endpoint that you want to ingest into Splunk.
Add a New Data Input
Navigate to Vectra RUX Technology Add-on.
Open Inputs.
Select Create New Input or Add Input, depending on the option available in your Splunk interface.
Select the input type and configure the required fields.
Save the input and confirm that it is enabled.
Data Input Configuration Fields
Create a separate input for each Vectra account and endpoint that you want to ingest. Configure the following fields for the selected input type.
Entity Scoring Input Fields
Name: A unique name for the data input.
Interval: How often Splunk polls the selected Vectra endpoint, in seconds.
Index: The Splunk index where collected events are stored.
Vectra RUX Account: The configured Vectra RUX account used to authenticate to the endpoint.
Historical Data: When enabled, collects the previous 24 hours of data on the first collection cycle.
Detection Input Fields
Name: A unique name for the data input.
Interval: How often Splunk polls the selected Vectra endpoint, in seconds.
Index: The Splunk index where collected events are stored.
Vectra RUX Account: The configured Vectra RUX account used to authenticate to the endpoint.
Historical Data: When enabled, collects the previous 24 hours of data on the first collection cycle. This option is available only for Entity Scoring, Detection, and Audit inputs.
From Checkpoint ID: An optional event id from which collection begins on the first run. Use it when you want collection to start after a specific event instead of collecting the previous 24 hours.
Include Triaged: Include triaged detections.
Include Info Category: Include informational detections.
Input Start Time: Select the event timestamp source used for data collection.
Audit Input Fields
Name: A unique name for the data input.
Interval: How often Splunk polls the selected Vectra endpoint, in seconds.
Index: The Splunk index where collected events are stored.
Vectra RUX Account: The configured Vectra RUX account used to authenticate to the endpoint.
Lockdown Input Fields
Name: A unique name for the data input.
Interval: How often Splunk polls the selected Vectra endpoint, in seconds.
Index: The Splunk index where collected events are stored.
Vectra RUX Account: The configured Vectra RUX account used to authenticate to the endpoint.
Health Input Fields
Name: A unique name for the data input.
Interval: How often Splunk polls the selected Vectra endpoint, in seconds. Use 900 seconds for the Health input.
Index: The Splunk index where collected events are stored.
Vectra RUX Account: The configured Vectra RUX account used to authenticate to the endpoint.
Get Health EDR: Collect data from the health EDR endpoint.
Get Health EDR Details: Collect data from the detailed health EDR endpoint.
Get Health External Connectors: Collect data from the health external connectors endpoint.
Get Health External Connectors Details: Collect data from the detailed health external connectors endpoint.
Recommended Input Interval
For Entity Scoring, Detection, Audit, and Lockdown inputs, an interval of 60 seconds is recommended. Splunk checks the configured endpoint every 60 seconds and collects available data.
Health Input Interval
For the Health input, use an interval of 900 seconds. Health data is refreshed every 15 minutes on the Vectra side, so the longer interval avoids unnecessary polling and aligns Splunk collection with the data refresh cycle.
Historical Data Option
Historical Data is optional. When enabled, the input collects data from the previous 24 hours. This can be useful in smaller environments when verifying that the add-on is working and data is reaching Splunk.
Use From Checkpoint ID with the latest event id when you need to resume collection without re-ingesting the previous 24 hours. Do not use detection_id as the checkpoint value.
Use this Splunk search to retrieve the latest event id:
Copy the id field from the result into From Checkpoint ID. Do not use detection_id.
Verify Data Input Configuration
After creating data inputs:
Confirm that each required input appears in the Inputs table.
Verify that its status is Enabled.
Confirm that the correct Vectra account and Splunk index are selected.
Wait for the configured interval to pass.
Verify that data is being ingested by searching the configured index in Splunk Search.

3. Install the Vectra RUX App
The Vectra RUX App for Splunk provides dashboards and visualizations using the data collected by the Vectra RUX Technology Add-on for Splunk. Install this app after the Technology Add-on has been installed and configured.
Install the App in Splunk Cloud
Install the Vectra RUX App in Splunk Cloud Platform using one of the supported installation methods.
Option 1: Install from Splunkbase in Splunk Cloud (Recommended)
Log in to Splunk Cloud Platform with an account that has the required administrative permissions.
From the Splunk Home page, navigate to Apps > Find More Apps.
Search for Vectra RUX App.
Select the app and click Install.
When prompted, enter your Splunk.com credentials and accept the license terms.
After installation completes, verify that the app appears under Apps > Manage Apps.
Option 2: Install from an App Package
Download the Vectra RUX App package from Splunkbase.
Log in to Splunk Cloud Platform with the required administrative permissions.
Navigate to Apps > Manage Apps.
Select Install app from file or Upload App, depending on your Splunk Cloud experience.
Click Choose File and select the downloaded app package.
Click Upload and follow the prompts.
Wait for Splunk Cloud to validate the app package.
After installation completes, confirm that the app appears under Apps > Manage Apps.
Note: Depending on your Splunk Cloud deployment and permissions, app package uploads may require validation or assistance from Splunk Support.
After the app is installed, dashboards will begin populating once the Vectra RUX Technology Add-on successfully ingests data into the configured index.
Configuration
No additional configuration is required if the data collected by the add-on is stored in the default Splunk index:
However, if you configured the data inputs to send data to an index other than main, you must update the app macro so that the dashboards search the correct index.
Important: Updating the vectra_xdr_index_macro is required for the Vectra RUX App for Splunk to display data correctly when a custom index is used. If this macro is not updated, the dashboards may not show Vectra data because the app will continue searching the default main index.
Configure the App Index
In the new Vectra RUX App for Splunk, you do not need to update the vectra_xdr_index_macro manually.
Log in to Splunk Web.
Open Vectra RUX App for Splunk.
Go to the Configuration section.
Select the index where the Vectra RUX Technology Add-on stores data from the Index drop-down.
Click Save.
Open the dashboards and confirm that data is displayed.
The app uses the selected index for its dashboard searches.
Uninstall and Cleanup Steps
To remove the Vectra RUX Splunk integration from Splunk Cloud Platform, complete the following steps.
Disable Data Inputs
In Splunk Cloud Platform, open the Vectra RUX Technology Add-on.
Navigate to Inputs.
Disable each configured Vectra data input.
Confirm that data ingestion has stopped before continuing with the uninstall process.
Remove Account Configurations
Navigate to Vectra RUX Technology Add-on > Configuration > Account.
Delete the Vectra SaaS account entries associated with the configured API clients.
Confirm that all Vectra account configurations have been removed.
Uninstall the Vectra RUX App and Technology Add-on
In Splunk Cloud Platform, navigate to Apps > Manage Apps.
Locate the Vectra RUX App.
Select Uninstall and follow the prompts.
Locate the Vectra RUX Technology Add-on.
Select Uninstall and follow the prompts.

Note: If the uninstall option is not available in Splunk Cloud, contact Splunk Support or use the supported Splunk Cloud app management workflow for your deployment.
Cleanup Considerations
Direct filesystem cleanup steps, such as removing files from $SPLUNK_HOME/etc/apps/ or deleting logs from $SPLUNK_HOME/var/log/, apply to self-managed Splunk Enterprise deployments and are not applicable to Splunk Cloud Platform.
Restarting Splunk is also handled by Splunk Cloud as part of the managed service. If a restart or additional cleanup is required, contact Splunk Support.
Uninstalling the app and add-on does not automatically remove indexed Vectra data. If historical Vectra data must also be removed, review your organization’s data retention requirements and coordinate with your Splunk Cloud administrator or Splunk Support.
Troubleshooting
General Checks
For Splunk Cloud Platform, Vectra RUX Technology Add-on logs are not accessed directly from the filesystem. Instead, use Splunk Search to review logs from the _internal index.
To list available Splunk internal log sources from the last 24 hours, run:
To identify Vectra-related log sources, run:
This is useful when troubleshooting the Vectra RUX integration because it helps identify which Vectra-related log files are available in Splunk Cloud.

Example Vectra log sources may include:
Search Add-on Logs
To view all Vectra RUX Technology Add-on logs in Splunk Cloud, run:
To view only error messages from the add-on logs, run:
You can also search all Vectra-related internal logs by using:

Data Collection Troubleshooting
If Vectra data is not being collected, verify the following:
The Vectra SaaS account configuration is correct.
The API client credentials are valid.
The configured API client has the required role and permissions for the endpoint.
The data input is enabled.
The configured index exists and is searchable.
Network connectivity to the Vectra platform is available.
If a proxy is used, confirm that the proxy configuration is correct and that the proxy can reach the Vectra platform.
Review the relevant log source based on the input being troubleshot:
Entity Scoring
ta_vectra_xdr_entity_scoring_input*.log
Detections
ta_vectra_xdr_detections_input*.log
Audits
ta_vectra_xdr_audits_input*.log
Lockdown
ta_vectra_xdr_lockdown_input*.log
Health
ta_vectra_xdr_health_input*.log
Account validation
ta_vectra_xdr_account_validation.log
Common add-on logs
ta_vectra_xdr_common.log
For example, to troubleshoot detection input logs, run:

Validate Collected Data
To confirm that Vectra data is being written to the configured index, run searches using the correct source and sourcetype values.
To check all supported Vectra RUX data types in the configured index, run:
You can also validate each data type individually.
Health Data
Detection Data
Audit Data
Entity Scoring Data
Lockdown Data
If these searches return events, the Vectra RUX Technology Add-on is successfully collecting data and writing it to the configured index. If no events are returned, verify that the related data input is enabled, the selected index is correct, and the corresponding Vectra SaaS account is configured with the correct API client credentials.
Dashboard Not Populating
If the Vectra RUX App dashboards are not displaying data, verify the following:
Confirm that Vectra data is being collected in the configured index.
Confirm that the correct sourcetypes are present.
Confirm that the
vectra_xdr_index_macromacro is updated to reference the index used by the Vectra RUX Technology Add-on.Confirm that the time range selected in the dashboard includes the time period when data was collected.
Add-on Icons Not Displaying
The Vectra RUX Technology Add-on does not require a restart for its core functionality after installation. However, app or add-on icons may not appear immediately in the Splunk UI.
In Splunk Cloud Platform, restarts are managed by Splunk Cloud. If icons do not appear after installation and a restart is required, contact Splunk Support or use the supported restart workflow for your Splunk Cloud deployment.
Integration of Splunk with Vectra Stream
There are 3 main steps required to integrate Splunk with Vectra Stream:
Installation and configuration of "Technology Add-on for Vectra Stream (JSON) ".
Installation of "Vectra Stream " App.
Configuring Vectra Stream to send metadata to Splunk using Publisher of "Raw JSON" using Protocol of "TCP" to the server IP/Hostname and port number of your choice where Splunk will be listening.
For details please see the Splunk Integration Guide for Vectra AI .
Last updated
Was this helpful?