VMWare Carbon Black Cloud Endpoint Standard

LAST UPDATED: AUG 5, 2025

Overview

Carbon Black EDR is an incident response and threat hunting solution designed for security operations center (SOC) teams with offline environments or on-premises requirements.

D3 SOAR is providing REST operations to function with VMWare Carbon Black Cloud Endpoint Standard.

VMWare Carbon Black Cloud Endpoint Standard is available for use in:

Connection

To connect to VMWare Carbon Black Cloud Endpoint Standard from D3 SOAR, please follow this part to collect the required information below:

Permission Requirements

Each endpoint in the VMWare Carbon Black Cloud Endpoint Standard API requires a certain permission scope. The following are required scopes for the commands in this integration:

As VMWare Carbon Black Cloud Endpoint Standard is using role-based access control (RBAC), the API 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 VMWare Carbon Black Cloud Endpoint Standard console for each command in this integration.

READER NOTE

VMWare Carbon Black Cloud Endpoint Standard’s default user profiles (sorted from the most permissions to the least) are as follows:

• Global administrator

• Analyst

• Viewer

• No Access

For instructions on configuring user permissions, refer to page 43 of the VMware Carbon Black EDR user guide. To enable the Global administrator permission, navigate to Users > User Management > User, then select a user.

Configuring VMWare Carbon Black Cloud Endpoint Standard to Work with D3 SOAR

Obtaining the API Token

1. Log in to the Carbon Black EDR console.

2. Click Username > My Profile.

   

3. Click API Token.

4. Copy and save the API token in a secure location. It will be required for setting up the integration connection in D3 SOAR.

Configuring User Permissions

Each command requires a certain permission scope. Refer to Permission Requirements for the list of required permissions for each command.

For instructions on configuring user permissions, refer to page 50 of the VMware Carbon Black EDR user guide. To enable the Global administrator permission, navigate to Users > User Management > User, then select a user.

Configuring D3 SOAR to Work with VMWare Carbon Black Cloud Endpoint Standard

1. Log in to D3 SOAR.

2. Find the VMWare Carbon Black Cloud Endpoint Standard integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type VMWare Carbon Black Cloud Endpoint Standard in the search box to find the integration, then click it to select it.

   4. Click + Connection, on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to VMWare Carbon Black Cloud Endpoint Standard.

   

   1. Connection Name: The desired name for the connection.

   2. Site: The site on which to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. 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.

   4. Agent Name (Optional): 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.

   5. Description (Optional): The description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, users can choose the specific tenant sites with which to share the connection. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.

      

   7. Configure User Permissions: Defines which users have access to the connection.

   8. Active: The checkbox that enables the connection to be used when selected.

   9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.

      

      
      1. Input the domain level Server URL.
      2. Copy the API Token from the VMWare Carbon Black Cloud Endpoint Standard platform. Refer to Obtaining the API Token in Configuring VMWare Carbon Black Cloud Endpoint Standard to Work with D3 SOAR.
      3. Input the API Version. The default value is v1.

   10. 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.

4. Test the connection.

   1. 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.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

VMWare Carbon Black Cloud Endpoint Standard includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, users can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the VMWare Carbon Black Cloud Endpoint Standard API, refer to the VMWare Carbon Black Cloud Endpoint Standard API reference.

READER NOTE

Certain permissions are required for each command. Refer to the Permission Requirements and Configuring VMWare Carbon Black Cloud Endpoint Standard to Work with D3 SOAR 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:

1. Navigate to Configuration > Application Settings. Select Date/Time Format.

   

2. 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.

Block Hashes

Blocks file hashes in VMware Carbon Black EDR.

Input

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or 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 you locate the root cause of a command failure.

Create Watchlist

Creates a watchlist in VMware Carbon Black EDR.

Input

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is 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 you locate the root cause of a command failure.

Fetch Event

Fetches events from VMware Carbon Black EDR into D3 SOAR.

Input

Output

To view the sample output data for all commands, refer to this article.

Fetch Event Field Mapping

Please note that Fetch Event commands require event field mapping. Field mapping plays a key role in the data normalization process part of the event pipeline. Field mapping converts the original data fields from the different providers to the D3 fields which are standardized by the D3 Model. Please refer to Event and Incident Intake Field Mapping for details.

If you require a custom field mapping, click + Add Field to add a custom field mapping. You can also remove built-in field mappings by clicking x. Please 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 VMWare Carbon Black Cloud Endpoint Standard 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, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched events. The default event source has a “Main Event JSON Path” (i.e., $.results) that is used to extract a batch of events from the response raw data. Click Edit Main JSON Path to view the “Main Event JSON Path”.

  

  • Main Event JSON Path: $.results
    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 results. The child node denoting the Alert Timestamp field would be created_time. Putting it together, the JSON Path expression to extract the Alert Timestamp is $.results.created_time.

READER NOTE
The Unique Event Key field mapping is used to prevent duplicate event ingestions. D3 SOAR will check if the value of a selected JSON path matches any Unique Event Key of previously ingested events. If a match is found, the event will be dismissed. If no match is found, an event will be created. However, if no Unique Event Key is mapped, then the hash value from the event pending ingestion will be used to check for any matches with existing events. If no match is found, the event will be created.

Unlike most other D3 SOAR integrations, the VMWare Carbon Black Cloud Endpoint Standard integration’s Fetch Event command’s Default Event Source mapping does not include Unique Event Key in order to fetch the same fetched target with multiple updates.

The pre-configured field mappings are detailed below:

Error Handling

If the Return Data is 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 you locate the root cause of a command failure.

Get Alerts

Retrieve alerts from VMware Carbon Black EDR.

Input

N/A

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is 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 you locate the root cause of a command failure.

Unblock Hashes

Unblock previously blocked file hashes in VMware Carbon Black EDR.

READER NOTE

Hashes must be previously blocked in order to unblock them. Attempting to unblock hashes that haven't been blocked will result in a "not found" error.

Input

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or 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 you locate the root cause of a command failure.