Trend Vision One v3.0
LAST UPDATED: MARCH 17, 2025
Overview
Trend Vision One is a purpose-built threat defense platform that extends beyond traditional XDR solutions, allowing users to gain deeper visibility and respond more quickly to threats. Integration with Trend Vision One supports major security operations commonly used by users, such as adding file hashes to a blocklist, quarantining or deleting email messages, isolating or restoring endpoints, terminating processes, fetching events, and updating alert statuses.
D3 SOAR is providing REST operations to function with Trend Vision One v3.0.
Trend Vision One v3.0 is available for use in:
Known Limitations
Trend Vision One v3.0 enforces rate limits on API endpoints to prevent performance issues. The rate limit measures API requests within 60 seconds. Exceeding the limit results in failed requests until the rate falls below the threshold.
API Rate Limit Exceeded: Returns HTTP 429 (Too many API requests).
Request Body Size: Maximum 1 MB; exceeding this returns HTTP 413.
Request Timeout: If an API takes longer than 60 seconds to respond, HTTP 504 is returned.
Refer to API Request Limits | Trend Vision One Automation Center for detailed information.
Connection
To connect to Trend Vision One v3.0 from D3 SOAR, follow this part to collect the required information below:
Parameter | Description | Example |
Server URL | The Trend Vision One URL. | https://api.xdr.trendmicro.com |
Authentication Token | The token used for authenticating the connection. | ***** |
Permission Requirements
Each endpoint in the Trend Vision One v3.0 API requires a certain permission scope. The following are the minimum required scopes for the commands in this integration:
Command | Minimum Required Scopes |
Fetch Event | XDR Threat Investigation
|
Get ES Endpoint Details | Endpoint Security
|
List Endpoint Inventory | Endpoint Security
|
Test Connection | Workflow And Automation
|
As Trend Vision One v3.0 is using role-based access control (RBAC), the Authentication Token is generated based on a specific user account and the application. Therefore, the command permissions are inherited from the user account’s role. Users need to configure their user profile from the Trend Vision One v3.0 console for each command in this integration.
Configuring Trend Vision One v3.0 to Work with D3 SOAR
Log into Trend Vision One v3.0.
Hover over the
icon, then select the User Roles option.
Click the Add Role button.
Name the role, then navigate to the Permissions tab.
Configure the permission scopes. For example, a role with the minimum required scopes to use the Fetch Event command can be set as follows:
Open the XDR Threat Investigation accordion.
Select the View, filter, and search option under the Workbench section.
The View Execution Profile option is automatically checked upon selecting the View, filter, and search option.Select the View, filter, and search option under the Observed Attack Techniques section.
Click the Save button.
Hover over the
icon, then select the API Keys option.
Click the Add API Key button
Fill the Add API Key form.
Name the key.
Select the configured role.
Set an expiration time.
Click the Add button.
Copy the API Key Value and save it in a secure location. Refer to step 3i sub-step 2 in Configuring D3 SOAR to Work with Trend Vision One v3.0.
The API key value cannot be retrieved past this point.
Configuring D3 SOAR to Work with Trend Vision One v3.0
Log in to D3 SOAR.
Find the Trend Vision One v3.0 integration.
Navigate to Configuration on the top header menu.
Click on the Integration icon on the left sidebar.
Type Trend Vision One v3.0 in the search box to find the integration, then click it to select it.
Click on the + Connection button on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Trend Vision One v3.0.
Connection Name: The desired name for the connection.
Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
Recipient site for events from connections Shared to Internal Sites: This field is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.
Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
Description (Optional): Add a description for the connection.
Tenant (Optional): When configuring the connection from a master tenant site, users have the option to choose the specific tenant sites to share the connection with. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.
Active: Check the checkbox to ensure the connection is available for use.
Configure User Permissions: Defines which users have access to the connection.
System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
1. Input the Server URL. The default value is https://api.xdr.trendmicro.com.
2. Copy the Authentication Token from the Trend Vision One v3.0 platform. Refer to step 9 of Configuring Trend Vision One v3.0 to Work with D3 SOAR.
Connection Health Check: Periodically checks the connection status by scheduling the Test Connection command at the specified interval (in minutes). Available only for active connections, this feature also allows configuring email notifications for failed attempts.
Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.
Test the connection.
Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.
Click OK to close the alert window.
Click + Add to create and add the configured connection.
Commands
Trend Vision One v3.0 includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command function, users can execute these commands independently for playbook troubleshooting.
Integration API Note
For more information about the Trend Vision One v3.0 API, refer to the Trend Vision One v3.0 API reference.
READER NOTE
Certain permissions are required for each command. Refer to the Permission Requirements and Configuring Trend Vision One v3.0 to Work with D3 SOAR sections for details.
Note for Time-related parameters
The input format of time-related parameters may vary based on user account settings, which may cause the sample data in commands to differ from what is displayed. To adjust the time format, follow these steps:
Navigate to Configuration Application Settings. Select Date/Time Format.
Choose the desired date and time format, then click on the Save button.
The selected time format will now be visible when configuring Date/Time command input parameters.
Fetch Event
Returns Workbench Alerts or Observed Attack Techniques Events from the Trend Vision One platform.
READER NOTE
Endpoint Host Names is an optional parameter to run this command.
Run the List Endpoint Inventory command to obtain the Endpoint Host Names. Endpoint Host Names can be found in the raw data at the path $.items[*].endpointName.
Input
Input Parameter | Required/Optional | Description | Example |
Event Type | Required | The type of events to return. Available options are:
| Observed Attack Techniques Event |
Start Time | Required | The start of the data retrieval range in UTC. For Observed Attack Techniques events, the data retrieval time range cannot be greater than 365 days. | 2023-05-08 00:00:00 |
End Time | Optional | The end of the data retrieval range in UTC. Ensure that End Time is not earlier than Start Time. By default, the value is the current time. | 2023-05-11 00:00:00 |
Query Time Type | Required | The field used to apply Start Time and End Time. Available options are:
For Workbench Alerts, choose Created Date Time or Updated Date Time. For Observed Attack Techniques events, choose Detected Date Time or Ingested Date Time. | Observed Attack Techniques Event-Detected Date Time |
Number of Event(s) Fetched | Optional | The maximum number of the most recent events to retrieve. Available options are:
By default, all events that match the filter criteria will be returned. | 50 |
Status | Optional | This parameter applies only to Workbench Alerts. Filters alerts by status. Available options are:
By default, all alerts regardless of their status will be returned. | Open |
Alert Provider | Optional | This parameter applies only to Workbench Alerts. Filters alerts by source. Available options are:
By default, all alerts regardless of their source will be returned. | SAE |
Severity | Optional | This parameter applies to both Workbench Alerts and Observed Attack Techniques Events. Filters by the severity assigned to a model that triggered the alert or the risk level assigned to a detection. Available options are:
By default, all events regardless of their severity or risk level will be returned. | High |
Endpoint Host Names | Optional | This parameter applies only to Observed Attack Techniques Events. Filters Observed Attack Techniques events by the host names of the endpoints. Host names can be obtained using the List Endpoint Inventory command. |
JSON
|
Mitre Tactic IDs | Optional | This parameter applies only to Observed Attack Techniques Events. Filters events by the IDs of associated MITRE ATT&CK tactics. Events will be returned if they match at least one of the specified IDs. If multiple IDs are provided, events associated with any ID not in the input list will be excluded. |
JSON
|
Mitre Technique IDs | Optional | This parameter applies only to Observed Attack Techniques events. Filters events by the IDs of associated MITRE ATT&CK techniques or sub-techniques. |
JSON
|
Search Condition | Optional | This parameter applies to both Workbench Alerts and Observed Attack Techniques Events. Filters events using a custom filter statement when the predefined filter parameters do not meet the user's requirements. For example:
| filterName eq 'System-Defined Event Logs Clearing via Wevtutil' |
Tolerance Scope | Optional | The tolerance scope (in minutes) for the query to fetch events between the specified Start Time and End Time to avoid event loss or fetch failure. If Tolerance Scope is specified, events will be fetched between {Start Time - Tolerance Scope, End Time}. By default, the value is 0. | 0 |
Output
To view the sample output data for all commands, refer to this article.
Fetch Event Field Mapping
Fetch Event commands require event field mapping. Field mapping plays a key role for data normalization within the event pipeline. Field mapping converts the original data fields from the different providers to standardized D3 fields as defined by the D3 Model. Refer to Event and Incident Intake Field Mapping for details.
To add a custom field, click on the + Add Field button. Users can also remove built-in field mappings by clicking x. Note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.
As a system integration, the Trend Vision One v3.0 integration has some pre-configured field mappings for default field mapping.
Default Event Source
The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, users will find a set of field mappings provided by the system. Default event source provides field mappings for common fields from the fetched data. The default event source has a "Main Event JSON Path" (i.e. $.items) that is used to extract a batch of events from the response raw data. View the "Main Event JSON Path" by clicking on the Edit Event Source button.
Main Event JSON Path: $.items
The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks ([‘...’]) should be used to separate child elements in JSON arrays.
For example, the root node of a JSON Path is items. The child node denoting the Event Type field would be model. Putting it together, the JSON Path expression to extract the Event Type is $.items.model.
The pre-configured field mappings are detailed below:
Field Name | Source Field |
Default | |
Email Address | .impactScore.entities[?(@.entityType=='emailAddress')].entityValue |
Command Line | .indicators[?(@.type=='command_line' && @.field=='objectCmd')].value |
Hostname Indicator | .indicators[?(@.field=='endpointHostName')].value |
Score | .score |
Document ID | .id |
Device IP address | .impactScore.entities[?(@.entityType=='host')].entityValue.ips |
Event Type | .model |
File Hash SHA256 | .indicators[?(@.type=='file_sha256'].value |
Filepath | .indicators[?(@.type=='fullpath' && @.field=='objectFilePath')].value |
File Hash SHA1 | .indicators[?(@.type=='file_sha1'].value |
Hostname | .impactScore.entities[?(@.entityType=='host')].entityValue.name |
Description | .description |
Process command line | .indicators[?(@.type=='command_line' && @.field=='processCmd')].value |
Process file path | .indicators[?(@.type=='fullpath' && @.field=='processFilePath')].value |
Start Time | .createdDateTime |
Parent process commandline | .indicators[?(@.type=='command_line' && @.field=='parentCmd')].value |
Source | .alertProvider |
Status | .status |
Sub Event | .matchedRules[*].matchedFilters[*].matchedEvents[*].uuid |
Severity | .severity |
Techniques | .matchedRules[*].matchedFilters[*].mitreTechniqueIds |
Username | .impactScore.entities[?(@.entityType=='account')].entityValue |
Observed Attack Techniques Event (Search String: {$.eventType}=oatEvent) | |
Agent GUID | .endpoint.agentGuid |
toRecipients | .detail.mailToAddresses |
Username | .filters[*].highlightedObjects[?(@.field=='logonUser' && @.type=='user_account')].value |
Source IP address | .filters[*].highlightedObjects[?(@.field=='src' && @.type=='ip')].value |
Source port | .filters[*].highlightedObjects[?(@.field=='spt' && @.type=='port')].value |
Email subject | .filters[*].highlightedObjects[?(@.type=='email_subject' && @.field=='mailMsgSubject')].value |
Tactics | .filters[*].mitreTacticIds |
Techniques | .filters[*].mitreTechniqueIds |
Parent process image path | .filters[*].highlightedObjects[?(@.field=='parentFilePath'].value |
Process command line | .filters[*].highlightedObjects[?(@.field=='processCmd'].value |
Start Time | .detectedDateTime |
Description | .filters[].description |
Process file path | .filters[*].highlightedObjects[?(@.field=='processFilePath'].value |
Process ID | .filters[*].highlightedObjects[?(@.field=='processPid')].value |
Raw event data | .filters[*].highlightedObjects[?(@.field=='objectRawDataStr')].value |
Registry key name | .filters[*].highlightedObjects[?(@.field=='objectRegistryKeyHandle'].value |
Registry value data | .filters[*].highlightedObjects[?(@.field=='objectRegistryData'].value |
Registry value name | .filters[*].highlightedObjects[?(@.field=='objectRegistryValue'].value |
Sender | .detail.mailFromAddresses |
Severity | .detail.filterRiskLevel |
Message ID | .filters[*].highlightedObjects[?(@.type=='email_message_id' && @.field=='mailMsgId')].value |
Action taken | .filters[*].highlightedObjects[?(@.field=='act')].value |
Parent process commandline | .filters[*].highlightedObjects[?(@.type=='command_line' && @.field=='parentCmd')].value |
Internal message ID | .filters[*].highlightedObjects[?(@.type=='email_message_unique_id' && @.field=='msgUuid')].value |
File Hash SHA1 | .filters[*].highlightedObjects[?(@.field=='processFileHashSha1'].value |
Filepath | .filters[*].highlightedObjects[?(@.field=='objectFilePath'].value |
Hostname | .endpoint.endpointName |
Event Type | .source |
Unique Event Key | .uuid |
Document ID | .id |
Device | .filters[*].highlightedObjects[?(@.field=='endpointHostName')].value |
Device IP address | .endpoint.ips |
Sender IP | .detail.mailSenderIp |
Content | .filters[*].highlightedObjects[?(@.field=='objectContentName')].value |
Destination IP address | .filters[*].highlightedObjects[?(@.field=='dst' && @.type=='ip')].value |
Destination port | .filters[*].highlightedObjects[?(@.field=='dpt' && @.type=='port')].value |
Policy ID | .filters[*].highlightedObjects[?(@.field=='policyId')].value |
Command Line | .filters[*].highlightedObjects[?(@.type=='command_line' && @.field=='objectCmd')].value |
Detection Filter | .filters[*].name |
Engine Operation | .filters[*].highlightedObjects[?(@.field=='engineOperation')].value |
Entity Name | .entityName |
Entity Type | .entityType |
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Fetch Event failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Trend Vision One v3.0 portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: The Query Time Type doesn't match the Event Type. |
Error Sample Data Fetch Event failed. Status Code: 400. Message: The Query Time Type doesn't match the Event Type. |
Get ES Endpoint Details
Displays the detailed profiles of the specified endpoints.
READER NOTE
Endpoint IDs is a required parameter to run this command.
Run the List Endpoint Inventory command to obtain the Endpoint IDs. Endpoint IDs can be found in the raw data at the path $.items[*].agentGuid.
Input
Input Parameter | Required/Optional | Description | Example |
Endpoint IDs | Required | The agent GUIDs of the endpoints for which to retrieve profile details. Endpoint IDs can be obtained using the List Endpoint Inventory command. |
JSON
|
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get ES Endpoint Details failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Trend Vision One v3.0 portal. Refer to the HTTP Status Code Registry for details. | Status Code: 404. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Endpoint not found. Verify the user ID and try again. |
Error Sample Data Get ES Endpoint Details failed. Status Code: 404. Message: Endpoint not found. Verify the user ID and try again. |
List Endpoint Inventory
Displays a detailed list of the endpoint inventory.
READER NOTE
Endpoint Names is an optional parameter to run this command.
Run this command without filling in the Endpoint Names parameter to obtain the Endpoint Names. Endpoint Names can be found in the raw data at the path $.items[*].endpointName.
Input
Input Parameter | Required/Optional | Description | Example |
Endpoint Names | Optional | The host names of the endpoints for which to retrieve information. Endpoint names can be obtained by running the command without filling in this input parameter. |
JSON
|
OS Names | Optional | The operating system names of the endpoints for which to retrieve information. |
JSON
|
Isolation Status | Optional | Filters endpoints by isolation status. Available options are:
| Off |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Endpoint Inventory failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Trend Vision One v3.0 portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Access denied. |
Error Sample Data List Endpoint Inventory failed. Status Code: 403. Message: Access denied. |
Test Connection
Allows users to perform a health check on an integration connection. Users can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.
Input
N/A
Output
Output Type | Description | Return Data Type |
Return Data | Indicates one of the possible command execution states: Successful or Failed. The Failed state can be triggered by any of the following errors:
More details about an error can be viewed in the Error tab. | String |
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Test Connection failed. Failed to check the connector. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Trend Vision One v3.0 portal. Refer to the HTTP Status Code Registry for details. | Status Code: 403. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Access denied. |
Error Sample Data Test Connection failed. Failed to check the connector. Status Code: 403. Message: Access denied. |