VMware Carbon Black Cloud

Overview

VMware Carbon Black Cloud provides solutions such as endpoint detection and response (EDR), advanced threat hunting, and vulnerability management.

D3 SOAR is providing REST operations to function with VMware Carbon Black Cloud.

VMware Carbon Black Cloud is available for use in:

D3 SOAR	V12.7.83.0+
Category	Endpoint Security
Deployment Options	Option II, Option IV

Known Limitations

For a detailed breakdown of the specific rate limits, including the number of requests allowed within a given time frame and the response codes you might encounter when a limit is exceeded, please refer to VMware's official documentation.

Connection

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

Parameter	Description	Example
Server URL	The server URL of VMware Carbon Black Cloud EDR.	https://defense.conferdeploy.net
Organization Key	The organization key to authenticate the API connection.	***
Token	The token to authenticate the API connection.	***
App ID	The App ID to authenticate the API connection.	***
API Version	The version of the API to use for the connection.	v6

Permission Requirements

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

Command	Required Permission (Access Levels)
Command	Category	Permission Name	.Notion Name	Detailed permissions
Aggregation Search Enriched Events	Search	Events	org.search.events	CREATE + READ
Start Background Scan	Device	Background scan	device.bg-scan	EXECUTE
Block Hashes	Applications	Reputation	org.reputations	CREATE + READ
Update Device Policy	Device	Policy assignment	device.policy	UPDATE
Disable Bypass	Device	Bypass	device.bypass	EXECUTE
Enable Bypass	Device	Bypass	device.bypass	EXECUTE
Fetch Event (fetching for events Is Alert parameter = False only need the first row. Fetching Alerts Is Alert = True need row 1+2)	Search	Events	org.search.events	CREATE + READ
	Alerts	General information	org.alerts	READ
Fetch Related Events	Search	Events	org.search.events	CREATE + READ
Get Alert By ID	Alerts	General information	org.alerts	READ
Get Device Info	Device	General information	device	READ
Get Event Associated With Process	Search	Events	org.search.events	READ
Get Processes	Search	Events	org.search.events	CREATE + READ
Quarantine Host	Device	Quarantine	device.quarantine	EXECUTE
Search Alerts	Alerts	General information	org.alerts	READ
Search Devices	Device	General information	device	READ
Stop Background Scan	Device	Background scan	device.bg-scan	EXECUTE
Unblock hashes	Applications	Reputation	org.reputations	READ + DELETE
Unquarantine Host	Device	Quarantine	device.quarantine	EXECUTE
Test Connection	Alerts	General information	org.alerts	Read

Reader Note

The Test Connection command requires the "Alert Read Access Level" to run. However, for other commands, this level is not mandatory. A connector without the “Alert Read Access Level” will fail a test connection, but commands will still be able to run provided you have the required access levels enabled for your API key.

Configuring VMware Carbon Black Cloud to Work with D3 SOAR

Create Access Levels

To access the data in your Carbon Black Cloud integrations through APIs, you must determine the appropriate access level for your API. Refer to VMware's documentation step-by-step instructions.

Applying an Access Level to an API Key

Apply the custom access level to an API key. Refer to VMware's documentation step-by-step instructions. Copy and save the API key after configuration, it will be required to build the integration connection in D3 SOAR.

After completing your setup, you can find the Organization Key on the API Access page. The Token (API Secret Key) and App ID are available when you create the key. You will need this information when building a connector in D3 SOAR.

Configuring D3 SOAR to Work with VMware Carbon Black Cloud

Log in to D3 SOAR.
Find the VMware Carbon Black Cloud 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 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.
Configure the following fields to create a connection to VMware Carbon Black Cloud.
1. Connection Name: The desired name for the connection.
2. 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.
3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.
4. 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.
5. Description (Optional): Add your desired description for the connection.
6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you 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: Check the tick box to ensure the connection is available for use.
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 Server URL (domain level). The default value is https://defense.conferdeploy.net.
  2. Copy the Organization Key from the VMware Carbon Black Cloud platform. The Organization Key can be found on the API Access page. Refer to Configuring VMware Carbon Black Cloud to Work with D3 SOAR for instructions.
  3. Input the Token and App ID. Token (API Secret Key) and App ID can be obtained when creating the key. Refer to Configuring VMware Carbon Black Cloud to Work with D3 SOAR for instructions.
  4. Input the API Version. The default value is v6.
10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.
Test the connection.
1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.
2. Click OK to close the alert window.
3. Click + Add to create and add the configured connection.

Commands

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

Integration API Note

For more information about the VMware Carbon Black Cloud API, please refer to the VMware Carbon Black Cloud API reference.

Reader Note
Certain permissions are required for each command. Please refer to the Permission Requirements and Configuring VMware Carbon Black Cloud to Work with D3 SOAR for details.

Note for Time-related parameters

The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:

Navigate to Configuration > Application Settings. Select Date/Time Format.
Choose your desired date and time format.

After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.

Aggregation Search Enriched Events

Starts a search on enriched events that groups results by the specified aggregation field.

Input

Input Parameter	Required/Optional	Description	Example
Aggregration Field	Required	The field to aggregate the search results by. The available aggregation fields are Device ID and Process SHA256.	Device ID
Last Hours	Required	The time frame (in hours) prior to the current time to filter the search results.	48

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "results": [
        {
            "backend_timestamp": "2021-05-31T10:07:42.465Z",
            "device_group_id": ***,
            "device_id": "*****",
            "device_name": "*****",
            "device_policy_id": *****,
            "device_timestamp": "2021-05-31T10:06:55.123Z",
            "enriched": true,
            "enriched_event_type": "SYSTEM_API_CALL",
            "event_description": "The application \"<share><link hash=\"***************************************\">C:\\windows\\***\\***\\v*.*\\***.exe</link></share>\" attempted to list all processes, by calling the function \"*****\". The operation was successful.",
            "event_id": "*****",
            "event_type": "crossproc",
            "ingress_time": 1622455639299,
            "legacy": true,
            "num_devices": 1,
            "num_events": 64,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***\\v*.*\\*.exe",
            "process_pid": [
                *****
            ],
            "process_username": [
                "***\\***"
            ]
        },
        {
            "backend_timestamp": "2021-05-31T22:51:32.186Z",
            "device_group_id": ***,
            "device_id": "***",
            "device_name": "***\\***",
            "device_policy_id": ***,
            "device_timestamp": "2021-05-31T14:57:05.172Z",
            "enriched": true,
            "enriched_event_type": "SYSTEM_API_CALL",
            "event_description": "The application \"<share><link hash=\"***************************************\">C:\\windows\\***\\***\\v*.*\\***.exe</link></share>\" attempted to list all processes, by calling the function \"NtQuerySystemInformation\". The operation failed.",
            "event_id": "***************************************",
            "event_type": "crossproc",
            "ingress_time": 1622501470429,
            "legacy": true,
            "num_devices": 1,
            "num_events": 4,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***\\v*.*\\*.exe",
            "process_pid": [
                ****
            ],
            "process_username": [
                "***\\***"
            ]
        },
        {
            "backend_timestamp": "2021-05-31T22:26:00.887Z",
            "device_group_id": *****,
            "device_id": "*****",
            "device_name": "*****",
            "device_policy_id": *****,
            "device_timestamp": "2021-05-31T22:22:13.44Z",
            "enriched": true,
            "enriched_event_type": "SYSTEM_API_CALL",
            "event_description": "The application \"<share><link hash=\"***************************************\">C:\\windows\\***\\***\\v*.*\\***.exe</link></share>\" attempted to list all processes, by calling the function \"NtQuerySystemInformation\". The operation failed.",
            "event_id": "***************************************",
            "event_type": "crossproc",
            "ingress_time": 1622499924179,
            "legacy": true,
            "num_devices": 1,
            "num_events": 12,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***\\v*.*\\*.exe",
            "process_pid": [
                *****
            ],
            "process_username": [
                "***\\***"
            ]
        },
        {
            "alert_category": [
                "OBSERVED"
            ],
            "alert_id": [
                "*****"
            ],
            "backend_timestamp": "2021-06-01T09:01:14.623Z",
            "device_group_id": *****,
            "device_id": "*****",
            "device_name": "***\\***",
            "device_policy_id": ***,
            "device_timestamp": "2021-06-01T09:00:06.275Z",
            "enriched": true,
            "enriched_event_type": "CREATE_PROCESS",
            "event_description": "The application \"<share><link hash=\"***************************************\">C:\\windows\\***\\***\\v*.*\\***.exe</link></share>\" invoked the application \"<share><link hash=\"b9c76ec4bf6d6fe3f6f65e8f8fd0d344d3da310f903141ed24533aa36710e84b\">C:\\windows\\system32\\werfault.exe</link></share>\". ",
            "event_id": "*****",
            "event_type": "childproc",
            "ingress_time": 1622538054458,
            "legacy": true,
            "num_devices": 1,
            "num_events": 73,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***\\v*.*\\*.exe",
            "process_pid": [
                *****
            ],
            "process_username": [
                "***\\***"
            ]
        }
    ],
    "num_found": 48,
    "num_available": 48,
    "approximate_unaggregated": 0,
    "num_aggregated": 0,
    "contacted": 4,
    "completed": 3
}

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.results in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "backend_timestamp": "2021-05-31T10:07:42.465Z",
        "device_group_id": *****,
        "device_id": "*****",
        "device_name": "*****",
        "device_policy_id": *****,
        "device_timestamp": "2021-05-31T10:06:55.123Z",
        "enriched": true,
        "enriched_event_type": "SYSTEM_API_CALL",
        "event_description": "The application \"<share><link hash=\"***************************************\">C:\\windows\\***\\***\\v*.*\\*.exe</link></share>\" attempted to list all processes, by calling the function \"NtQuerySystemInformation\". The operation was successful.",
        "event_id": "*****",
        "event_type": "crossproc",
        "ingress_time": 1622455639299,
        "legacy": true,
        "num_devices": 1,
        "num_events": 64,
        "org_id": "*****",
        "parent_guid": "***************************************",
        "parent_pid": *****,
        "process_guid": "***************************************",
        "process_hash": [
            "***************************************",
            "***************************************"
        ],
        "process_name": "c:\\windows\\***\\***\\v*.*\\*.exe",
        "process_pid": [
            *****
        ],
        "process_username": [
            "***\\***"
        ]
    },
    {
        "backend_timestamp": "2021-05-31T22:51:32.186Z",
        "device_group_id": 0,
        "device_id": "*****",
        "device_name": "***\\***",
        "device_policy_id": *****,
        "device_timestamp": "2021-05-31T14:57:05.172Z",
        "enriched": true,
        "enriched_event_type": "SYSTEM_API_CALL",
        "event_description": "The application \"<share><link hash=\"***************************************\">C:\\windows\\***\\***\\v*.*\\*.exe</link></share>\" attempted to list all processes, by calling the function \"NtQuerySystemInformation\". The operation failed.",
        "event_id": "***************************************",
        "event_type": "crossproc",
        "ingress_time": 1622501470429,
        "legacy": true,
        "num_devices": 1,
        "num_events": 4,
        "org_id": "*****",
        "parent_guid": "***************************************",
        "parent_pid": *****,
        "process_guid": "***************************************",
        "process_hash": [
            "***************************************",
            "***************************************"
        ],
        "process_name": "c:\\windows\\***\\***\\v*.*\\*.exe",
        "process_pid": [
            *****
        ],
        "process_username": [
            "***\\***"
        ]
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "NumFound": "\"48\"",
    "NumAvailable": "\"48\"",
    "ApproximateUnaggregated": "\"0\"",
    "NumAggregated": "\"0\"",
    "Contacted": "\"4\"",
    "Completed": "\"3\""
}

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Aggregation Search Enriched Events 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 VMware Carbon Black Cloud portal. Refer to the HTTP Status Code Registry for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Access is denied.

Error Sample Data

Aggregation Search Enriched Events failed.

Status Code: 401.

Message: Access is denied.

Start Background Scan

Initiates a background scan on the given device IDs.

Reader Note

The parameter Device IDs is required to run this command.
- Run the Search Devices command to obtain Device IDs. Device IDs can be found in the returned raw data at the path $.results[*].id.
This command is not supported on devices with the Linux OS.

Input

Input Parameter	Required/Optional	Description	Example
Device IDs	Required	The array of device IDs to initiate the background scan. Device IDs can be obtained using the Search Devices command.	[************************]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "background_scan": true
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "background_scan": true
    }
]

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

DEVICE_ID	BACKGROUND_SCAN
*********   True

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Start Background Scan 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 VMware Carbon Black Cloud 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: NOT_FOUND:device_id(s) : [12345].

Error Sample Data

Start Background Scan failed.

Status Code: 404.

Message: NOT_FOUND:device_id(s) : [**********].

Block Hashes

Blocks SHA256 file hashes in VMware Carbon Cloud EDR.

Input

Input Parameter	Required/Optional	Description	Example
Hashes	Required	The array of SHA256 file hashes to block.	["**********************"]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "id": "***************************************",
        "created_by": "*****",
        "create_time": "2021-06-02T21:49:25.446Z",
        "override_list": "BLACK_LIST",
        "override_type": "SHA256",
        "description": "An override for a sha256 hash Wildfire",
        "source": "APP",
        "source_ref": null,
        "sha256_hash": "***************************************",
        "filename": null
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "id": "***************************************",
        "created_by": "*****",
        "create_time": "2021-06-02T21:49:25.446Z",
        "override_list": "BLACK_LIST",
        "override_type": "SHA256",
        "description": "An override for a sha256 hash Wildfire",
        "source": "APP",
        "source_ref": null,
        "sha256_hash": "***************************************",
        "filename": null
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "IDs": "\"[\\\"***************************************\\\"]\""
}

Return Data

Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.

The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Block hashes 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 VMware Carbon Black Cloud 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: error_code.

Error Sample Data

Block hashes failed.

Status Code: 400.

Message: error_code.

Update Device Policy

Updates device policies in VMware Carbon Black Cloud EDR.

Reader Note

Device IDs and Policy ID are required parameters to run this command.

Run the Search Devices command to obtain Device IDs. Device IDs can be found in the returned raw data at the path $.results[*].id.
Run the Fetch Event or Fetch Related Event commands to obtain policy IDs. Currently, there is no command to fetch a complete list of policy IDs. Only the mentioned two commands can return the associated policy IDs. Policy IDs can be found in the returned raw data of both commands at the path $.results[*].device_policy_id.

Input

Input Parameter	Required/Optional	Description	Example
Device IDs	Required	The IDs of the devices to update policies. Device IDs can be obtained using the Search Devices command.	[************************]
Policy ID	Required	The ID of the policy to update the devices to.	*****

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "policy_id": *****
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "policy_id": *****
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

$body

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

DEVICE_ID	POLICY_ID
*****  	    *****

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Update Device Policy 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 VMware Carbon Black Cloud 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: Forbidden.

Error Sample Data

Update Device Policy failed.

Status Code: 403.

Message: Forbidden.

Disable Bypass

Disables bypass on the specified devices.

Reader Note

The parameter Device IDs is required to run this command.

Run the Search Devices command to obtain Device IDs. Device IDs can be found in the returned raw data at the path $.results[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Device IDs	Required	The IDs of the devices to disable bypass. Device IDs can be obtained using the Search Devices command.	[*****]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "enable_bypass": false
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "enable_bypass": false
    }
]

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

DEVICE_ID	ENABLE_BYPASS
*****       False

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Disable Bypass 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 VMware Carbon Black Cloud 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: NOT_FOUND:device_id(s) : [*****].

Error Sample Data

Disable Bypass failed.

Status Code: 404.

Message: NOT_FOUND:device_id(s) : [*****].

Enable Bypass

Enable bypass on the specified devices.

Reader Note

The parameter Device IDs is required to run this command.

Run the Search Devices command to obtain Device IDs. Device IDs can be found in the returned raw data at the path $.results[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Device IDs	Required	The IDs of the devices to enable bypass. Device IDs can be obtained using the Search Devices command.	[*****]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "enable_bypass": true
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "enable_bypass": true
    }
]

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

DEVICE_ID	ENABLE_BYPASS
*****       True

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Enable Bypass 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 VMware Carbon Black Cloud 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: NOT_FOUND:device_id(s) : [*****].

Error Sample Data

Enable Bypass failed.

Status Code: 404.

Message: NOT_FOUND:device_id(s) : [*****].

Fetch Event

Retrieves all events or alerts based on the specified search condition.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Required	The start time of the time range to search alerts or events in UTC time.	2021-05-18 00:00
End Time	Required	The end time of the time range to search alerts or events in UTC time.	2021-05-22 00:00
Number of Event(s) Fetched	Required	The maximum number of the most recent events or alerts to return.	2
Search Condition	Required	The condition expression to search for related events or alerts.	event_type:regmod
Is Alert	Optional	The option to include alerts in the response data. The default option is False.	False

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "results": [
        {
            "backend_timestamp": "2021-05-18T00:04:29.072Z",
            "device_group_id": *****,
            "device_id": *****,
            "device_name": "*****\\*****",
            "device_policy_id": *****,
            "device_timestamp": "2021-05-18T00:02:06.92Z",
            "enriched": true,
            "enriched_event_type": "REGISTRY_ACCESS",
            "event_description": "The script \"C:\\windows\\***\\***.dll\" attempted to modify the Windows Registry Key\\Value Name = \"\\***\\***\\***\\***\\Windows\\***\\***\\***\". ",
            "event_id": "***************************************",
            "event_type": "regmod",
            "ingress_time": 1621296251737,
            "legacy": true,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***.dll",
            "process_pid": [
                *****
            ],
            "process_username": [
                "***\\***"
            ]
        },
        {
            "backend_timestamp": "2021-05-18T00:04:44.245Z",
            "device_group_id": ***************************************,
            "device_id": *****,
            "device_name": "***\\***",
            "device_policy_id": *****,
            "device_timestamp": "2021-05-18T00:02:07.584Z",
            "enriched": true,
            "enriched_event_type": "REGISTRY_ACCESS",
            "event_description": "The script \"C:\\windows\\***\\***.dll\" attempted to modify the Windows Registry Key\\Value Name = \"\\***\\***\\***\\***\\Windows\\***\\***\\***\". ",
            "event_id": "*****",
            "event_type": "regmod",
            "ingress_time": 1621296253778,
            "legacy": true,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\users\\***\\***\\***.msi",
            "process_pid": [
                *****
            ],
            "process_username": [
                "***\\***"
            ]
        }
    ],
    "num_found": 213,
    "num_available": 4,
    "approximate_unaggregated": 213,
    "num_aggregated": 4,
    "contacted": 11,
    "completed": 11
}

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.results in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "backend_timestamp": "2021-05-18T00:04:29.072Z",
        "device_group_id": *****,
        "device_id": *****,
        "device_name": "***\\***",
        "device_policy_id": *****,
        "device_timestamp": "2021-05-18T00:02:06.92Z",
        "enriched": true,
        "enriched_event_type": "REGISTRY_ACCESS",
        "event_description": "The script \"C:\\windows\\***\\***.dll\" attempted to modify the Windows Registry Key\\Value Name = \"\\***\\***\\***\\***\\Windows\\***\\***\\***\". ",
        "event_id": "***************************************",
        "event_type": "regmod",
        "ingress_time": 1621296251737,
        "legacy": true,
        "org_id": "*****",
        "parent_guid": "***************************************",
        "parent_pid": *****,
        "process_guid": "***************************************",
        "process_hash": [
            "***************************************",
            "***************************************"
        ],
        "process_name": "c:\\windows\\***\\***.dll",
        "process_pid": [
            *****
        ],
        "process_username": [
            "***\\***"
        ]
    },
    {
        "backend_timestamp": "2021-05-18T00:04:44.245Z",
        "device_group_id": *****,
        "device_id": *****,
        "device_name": "***\\***",
        "device_policy_id": *****,
        "device_timestamp": "2021-05-18T00:02:07.584Z",
        "enriched": true,
        "enriched_event_type": "REGISTRY_ACCESS",
        "event_description": "The script \"C:\\windows\\***\\***.dll\" attempted to modify the Windows Registry Key\\Value Name = \"\\***\\***\\***\\***\\Windows\\***\\***\\***\". ",
        "event_id": "*****",
        "event_type": "regmod",
        "ingress_time": 1621296253778,
        "legacy": true,
        "org_id": "*****",
        "parent_guid": "***************************************",
        "parent_pid": *****,
        "process_guid": "***************************************",
        "process_hash": [
            "***************************************",
            "***************************************"
        ],
        "process_name": "c:\\windows\\***\\***.msi",
        "process_pid": [
            *****
        ],
        "process_username": [
            "***\\***"
        ]
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "EventIDs": "\"[\\\"************\\\", \\\"************\\\"]\"",
    "EventTypes": "\"[\\\"************\\\",\\\"************\\\]\"",
    "DeviceNames": "\"[\\\"************\\\\\\\\************\\\",\\\"************\\\\\\\\************\\\"]\""
}

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

The VMware Carbon Black Cloud integration in D3 SOAR has some pre-configured field mappings for the event and alert, which correspond to the Default Event Source and VMware Carbon Black Cloud Alerts mappings:

Default Event Source
Configures the field mapping which are specific to the event-related events. If a source field in the field mapping is not found, the corresponding field mapping will be ignored. 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 Event Source 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 result. The child node denoting the Unique Event Key field would be event_id. Putting it together, the JSON Path expression to extract the Unique Event Key is $.result.event_id.
Event Source for VMware Carbon Black Cloud Alerts
Configures the field mapping which are specific to the alert-related events. If a source field in the field mapping is not found, the corresponding field mapping will be ignored. As the data of the alert-related events have a character that the value of the is_alert field is True, the alert-related events can be defined by the Search String: {$.is_alert}=True. Click Edit Event Source to view the Search String.

The pre-configured field mappings are detailed below:

Field Name	Source Field
Default Event Source (Main Event JSON Path: $.result)
Event code	.id
Unique Event Key	.event_id
Event Type	.event_type
Hostname	.device_name
Description	.event_description
Process GUID	.process_guid
Process Hash	.process_hash
Process Name	.process_name
Username	.process_username
Start time (UTC)	.process_start_time
VMware Carbon Black Cloud Alerts (Search String: {$.is_alert}=True) The search string format is {jsonpath}=value. If the value of the is_alert key is True in the event object under raw data, then the alert-related events will use the field mapping below.
Event category	.category
Unique Event Key	.legacy_alert_id
Event Type	.type
Hostname	.device_name
Description	.reason
Process GUID	.threat_cause_process_guid
Process Hash SHA256	.threat_indicators[*].sha256
Process Name	.process_name
Severity	.severity
Threat category	.threat_cause_threat_category
Threat event ID	.threat_id
Username	.device_username
UTCEventTime	.create_time

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.

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 VMware Carbon Black Cloud 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: Expecting value: line 1 column 1 (char 0).

Error Sample Data

Fetch Event failed.

Status Code: 403.

Message: Expecting value: line 1 column 1 (char 0).

Fetch Related Events

Retrieves related events based on the specified search condition.

Input

Input Parameter	Required/Optional	Description	Example
Last Hours	Required	The timeframe, in hours, before the current time to filter search results.	24
Top Recent Event Number	Required	The maximum number of the most recent events to return.	2
Search Condition	Required	The condition expression to search for related events.	event_type:regmod

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "results": [
        {
            "alert_category": [
                "OBSERVED"
            ],
            "alert_id": [
                "*****"
            ],
            "backend_timestamp": "2021-05-30T21:14:20.302Z",
            "device_group_id": *****,
            "device_id": *****,
            "device_name": "***\\***",
            "device_policy_id": *****,
            "device_timestamp": "2021-05-30T21:12:22.155Z",
            "enriched": true,
            "enriched_event_type": "REGISTRY_ACCESS",
            "event_description": "The script \"C:\\windows\\***\\***.dll\" attempted to modify the Windows Registry Key\\Value Name = \"\\***\\***\\***\\***\\Windows\\***\\***\\***\". ",
            "event_id": "***************************************",
            "event_type": "regmod",
            "ingress_time": 1622409220498,
            "legacy": true,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***.exe",
            "process_pid": [
                *****
            ],
            "process_username": [
                "***\\***"
            ]
        },
        {
            "backend_timestamp": "2021-05-30T21:47:02.271Z",
            "device_group_id": *****,
            "device_id": *****,
            "device_name": "***\\***",
            "device_policy_id": *****,
            "device_timestamp": "2021-05-30T21:45:39.092Z",
            "enriched": true,
            "enriched_event_type": "REGISTRY_ACCESS",
            "event_description": "The script \"C:\\windows\\***\\***.dll\" attempted to modify the Windows Registry Key\\Value Name = \"\\***\\***\\***\\***\\Windows\\***\\***\\***\". ",
            "event_id": "***************************************",
            "event_type": "regmod",
            "ingress_time": 1622411174735,
            "legacy": true,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***.exe",
            "process_pid": [
                *****
            ],
            "process_username": [
                "***\\***"
            ]
        }
    ],
    "num_found": 229,
    "num_available": 4,
    "approximate_unaggregated": 229,
    "num_aggregated": 4,
    "contacted": 5,
    "completed": 5
}

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.results in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "alert_category": [
            "OBSERVED"
        ],
        "alert_id": [
            "*****"
        ],
        "backend_timestamp": "2021-05-30T21:14:20.302Z",
        "device_group_id": *****,
        "device_id": *****,
        "device_name": "***\\***",
        "device_policy_id": *****,
        "device_timestamp": "2021-05-30T21:12:22.155Z",
        "enriched": true,
        "enriched_event_type": "REGISTRY_ACCESS",
        "event_description": "The script \"C:\\windows\\***\\***.exe\" attempted to modify the Windows Registry Key\\Value Name = \"\\***\\***\\***\\***\\Windows\\***\\***\\***\". ",
        "event_id": "***************************************",
        "event_type": "regmod",
        "ingress_time": 1622409220498,
        "legacy": true,
        "org_id": "*****",
        "parent_guid": "***************************************",
        "parent_pid": *****,
        "process_guid": "***************************************",
        "process_hash": [
            "***************************************",
            "***************************************"
        ],
        "process_name": "c:\\windows\\***\\***.exe",
        "process_pid": [
            *****
        ],
        "process_username": [
            "***\\***"
        ]
    },
    {
        "backend_timestamp": "2021-05-30T21:47:02.271Z",
        "device_group_id": *****,
        "device_id": *****,
        "device_name": "***\\***",
        "device_policy_id": *****,
        "device_timestamp": "2021-05-30T21:45:39.092Z",
        "enriched": true,
        "enriched_event_type": "REGISTRY_ACCESS",
        "event_description": "The application \"C:\\Windows\\***\\***.exe -k NetworkService\" attempted to modify the Windows Registry Key\\Value Name = \"\\***\\***\\***\\***\\Windows\\***\\***\\***\". ",
        "event_id": "***************************************",
        "event_type": "regmod",
        "ingress_time": 1622411174735,
        "legacy": true,
        "org_id": "*****",
        "parent_guid": "***************************************",
        "parent_pid": *****,
        "process_guid": "***************************************",
        "process_hash": [
            "***************************************",
            "***************************************"
        ],
        "process_name": "c:\\windows\\***\\***.exe",
        "process_pid": [
            *****
        ],
        "process_username": [
            "***\\***"
        ]
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "EventIDs": "\"[\\\"************\\\", \\\"************\\\"]\"",
    "EventTypes": "\"[\\\"***\\\",\\\"***\\\"]\"",
    "DeviceNames": "\"[\\\"***\\\\\\\\***\\\",\\\"***\\\\\\\\***\\\"]\""
}

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Fetch Related Events 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 VMware Carbon Black Cloud 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 value for parameter (Top Recent Event Number) is invalid.

Error Sample Data

Fetch Related Events failed.

Status Code: 400.

Message: The value for parameter (Top Recent Event Number) is invalid.

Get Alert By ID

Retrieves alerts based on the given alert IDs.

Reader Note

The parameter Alert IDs is required to run this command.

Run the Search Alerts command to obtain Alert IDs. Alert IDs can be found in the returned raw data at the path $.results[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Alert IDs	Required	The IDs of the alerts to retrieve. Alert IDs can be obtained using the Search Alerts command.	["**********************"]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "type": "WATCHLIST",
        "id": "***************************************",
        "legacy_alert_id": "***************************************",
        "org_key": "*****",
        "create_time": "2021-05-21T21:09:52.907Z",
        "last_update_time": "2021-05-21T21:09:52.907Z",
        "first_event_time": "2021-05-21T21:07:47.757Z",
        "last_event_time": "2021-05-21T21:07:47.757Z",
        "threat_id": "***************************************",
        "severity": 1,
        "category": "THREAT",
        "device_id": *****,
        "device_os": "WINDOWS",
        "device_os_version": null,
        "device_name": "***\\***",
        "device_username": "***\\***",
        "policy_id": *****,
        "policy_name": "default",
        "target_value": "LOW",
        "workflow": {
            "state": "OPEN",
            "remediation": null,
            "last_update_time": "2021-05-21T21:08:48.248Z",
            "comment": null,
            "changed_by": "Carbon Black"
        },
        "notes_present": false,
        "tags": null,
        "reason": "Process ***.exe was detected by the report \"Execution - Command-Line Interface (cmd.exe /c)\" in watchlist \"ATT&CK Framework\"",
        "count": 0,
        "report_id": "***************************************",
        "report_name": "Execution - Command-Line Interface (***.exe /c)",
        "ioc_id": "***",
        "ioc_field": null,
        "ioc_hit": "(((process_name:***.exe AND process_cmdline:\\/c) AND -childproc_name:***.exe)) -enriched:true",
        "watchlists": [
            {
                "id": "***************************************",
                "name": "ATT&CK Framework"
            }
        ],
        "process_guid": "***************************************",
        "process_name": "***.exe",
        "run_state": "RAN",
        "threat_indicators": [
            {
                "process_name": "***.exe",
                "sha256": "***************************************",
                "ttps": [
                    "*****"
                ]
            }
        ],
        "threat_cause_actor_sha256": "***************************************",
        "threat_cause_actor_md5": "***************************************",
        "threat_cause_actor_name": "c:\\windows\\***\\***.exe",
        "threat_cause_reputation": "TRUSTED_WHITE_LIST",
        "threat_cause_threat_category": "UNKNOWN",
        "threat_cause_vector": "UNKNOWN",
        "document_guid": "***************************************"
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "type": "WATCHLIST",
        "id": "***************************************",
        "legacy_alert_id": "***************************************",
        "org_key": "*****",
        "create_time": "2021-05-21T21:09:52.907Z",
        "last_update_time": "2021-05-21T21:09:52.907Z",
        "first_event_time": "2021-05-21T21:07:47.757Z",
        "last_event_time": "2021-05-21T21:07:47.757Z",
        "threat_id": "***************************************",
        "severity": 1,
        "category": "THREAT",
        "device_id": *****,
        "device_os": "WINDOWS",
        "device_os_version": null,
        "device_name": "***\\***",
        "device_username": "***\\***",
        "policy_id": *****,
        "policy_name": "default",
        "target_value": "LOW",
        "workflow": {
            "state": "OPEN",
            "remediation": null,
            "last_update_time": "2021-05-21T21:08:48.248Z",
            "comment": null,
            "changed_by": "Carbon Black"
        },
        "notes_present": false,
        "tags": null,
        "reason": "Process cmd.exe was detected by the report \"Execution - Command-Line Interface (***.exe /c)\" in watchlist \"ATT&CK Framework\"",
        "count": 0,
        "report_id": "***************************************",
        "report_name": "Execution - Command-Line Interface (***.exe /c)",
        "ioc_id": "***************************************",
        "ioc_field": null,
        "ioc_hit": "(((process_name:***.exe AND process_cmdline:\\/c) AND -childproc_name:***.exe)) -enriched:true",
        "watchlists": [
            {
                "id": "***************************************",
                "name": "ATT&CK Framework"
            }
        ],
        "process_guid": "***************************************",
        "process_name": "***.exe",
        "run_state": "RAN",
        "threat_indicators": [
            {
                "process_name": "***.exe",
                "sha256": "***************************************",
                "ttps": [
                    "*****"
                ]
            }
        ],
        "threat_cause_actor_sha256": "***************************************",
        "threat_cause_actor_md5": "***************************************",
        "threat_cause_actor_name": "c:\\windows\\***\\***.exe",
        "threat_cause_reputation": "TRUSTED_WHITE_LIST",
        "threat_cause_threat_category": "UNKNOWN",
        "threat_cause_vector": "UNKNOWN",
        "document_guid": "***************************************"
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "AlertIDs": "\"[\\\"***************************************\\\"]\"",
    "Categories": "\"[\\\"THREAT\\\"]\"",
    "DeviceNames": "\"[\\\"***\\\\\\\\***\\\"]\"",
    "DeviceUsernames": "\"[\\\"***\\\\\\\\***\\\"]\"",
    "Severities": "\"[1]\"",
    "ProcessNames": "\"[\\\"***.exe\\\"]\"",
    "Reasons": "\"[\\\"Process ***.exe was detected by the report \\\\\\\"Execution - Command-Line Interface (***.exe /c)\\\\\\\" in watchlist \\\\\\\"ATT&CK Framework\\\\\\\"\\\"]\""
}

Return Data

Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.

The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Alert By ID 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 VMware Carbon Black Cloud 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: Alert iD xxx BAD_REQUEST:Incorrect alert ID format. Must be in UUID format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. You must have a valid Support account to call this API.

Error Sample Data

Get Alert By ID failed.

Status Code: 400.

Message: Alert iD xxx BAD_REQUEST:Incorrect alert ID format. Must be in UUID format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. You must have a valid Support account to call this API.

Get Device Info

Retrieves device info based on the given device IDs.

Reader Note

The parameter Device IDs is required to run this command.

Run the Search Devices command to obtain Device IDs. Device IDs can be found in the returned raw data at the path $.results[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Device IDs	Required	The ID of the devices to return device info. Device IDs can be obtained using the Search Devices command.	[************************]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "activation_code": null,
        "activation_code_expiry_time": "2021-05-06T18:40:14.728Z",
        "ad_group_id": *****,
        "appliance_name": null,
        "appliance_uuid": null,
        "av_ave_version": null,
        "av_engine": null,
        "av_last_scan_time": null,
        "av_master": false,
        "av_pack_version": null,
        "av_product_version": null,
        "av_status": [
            "AV_DEREGISTERED"
        ],
        "av_update_servers": null,
        "av_vdf_version": null,
        "cluster_name": null,
        "current_sensor_policy_name": "USB Device Policy",
        "datacenter_name": null,
        "deployment_type": "ENDPOINT",
        "deregistered_time": "2021-05-25T16:53:55.253Z",
        "device_meta_data_item_list": [],
        "device_owner_id": *****,
        "email": "Siemplify Admin",
        "esx_host_name": null,
        "esx_host_uuid": null,
        "first_name": null,
        "id": *****,
        "last_contact_time": "2021-05-25T16:53:39.935Z",
        "last_device_policy_changed_time": "2021-05-24T19:35:59.269Z",
        "last_device_policy_requested_time": "2021-05-24T20:16:57.358Z",
        "last_external_ip_address": "***.***.***.***",
        "last_internal_ip_address": "***.***.***.***",
        "last_location": "OFFSITE",
        "last_name": null,
        "last_policy_updated_time": null,
        "last_reported_time": "2021-05-25T13:32:08.303Z",
        "last_reset_time": null,
        "last_shutdown_time": null,
        "linux_kernel_version": null,
        "login_user_name": "***\\***",
        "mac_address": "00090faa0001",
        "middle_name": null,
        "name": "*****",
        "organization_id": *****,
        "organization_name": "cb-internal-alliances.com",
        "os": "WINDOWS",
        "os_version": "Windows 10 x64",
        "passive_mode": false,
        "policy_id": *****,
        "policy_name": "USB Device Policy",
        "policy_override": true,
        "quarantined": false,
        "registered_time": "2021-04-29T18:40:14.816Z",
        "scan_last_action_time": null,
        "scan_last_complete_time": null,
        "scan_status": null,
        "sensor_kit_type": "WINDOWS",
        "sensor_out_of_date": false,
        "sensor_pending_update": false,
        "sensor_states": [
            "ACTIVE",
            "LIVE_RESPONSE_NOT_RUNNING",
            "LIVE_RESPONSE_NOT_KILLED",
            "LIVE_RESPONSE_ENABLED",
            "SECURITY_CENTER_OPTLN_DISABLED"
        ],
        "sensor_version": "*.*.*.*",
        "status": "DEREGISTERED",
        "target_priority": "HIGH",
        "uninstall_code": "*****",
        "vcenter_host_url": *****,
        "vcenter_name": *****,
        "vcenter_uuid": *****,
        "vdi_base_device": *****,
        "virtual_machine": false,
        "virtualization_provider": "UNKNOWN",
        "vm_ip": *****,
        "vm_name": *****,
        "vm_uuid": *****,
        "vulnerability_score": 0,
        "vulnerability_severity": null,
        "windows_platform": null
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "activation_code": null,
        "activation_code_expiry_time": "2021-05-06T18:40:14.728Z",
        "ad_group_id": *****,
        "appliance_name": *****,
        "appliance_uuid": *****,
        "av_ave_version": *****,
        "av_engine": null,
        "av_last_scan_time": null,
        "av_master": false,
        "av_pack_version": *****,
        "av_product_version": *****,
        "av_status": [
            "AV_DEREGISTERED"
        ],
        "av_update_servers": null,
        "av_vdf_version": *****,
        "cluster_name": *****,
        "current_sensor_policy_name": "USB Device Policy",
        "datacenter_name": null,
        "deployment_type": "ENDPOINT",
        "deregistered_time": "2021-05-25T16:53:55.253Z",
        "device_meta_data_item_list": [],
        "device_owner_id": *****,
        "email": "Siemplify Admin",
        "esx_host_name": *****,
        "esx_host_uuid": *****,
        "first_name": *****,
        "id": *****,
        "last_contact_time": "2021-05-25T16:53:39.935Z",
        "last_device_policy_changed_time": "2021-05-24T19:35:59.269Z",
        "last_device_policy_requested_time": "2021-05-24T20:16:57.358Z",
        "last_external_ip_address": "***.***.***.***",
        "last_internal_ip_address": "***.***.***.***",
        "last_location": "OFFSITE",
        "last_name": null,
        "last_policy_updated_time": null,
        "last_reported_time": "2021-05-25T13:32:08.303Z",
        "last_reset_time": null,
        "last_shutdown_time": null,
        "linux_kernel_version": *****,
        "login_user_name": "***\\***",
        "mac_address": "***************************************",
        "middle_name": *****,
        "name": "*****",
        "organization_id": *****,
        "organization_name": "cb-internal-alliances.com",
        "os": "WINDOWS",
        "os_version": "*****",
        "passive_mode": false,
        "policy_id": *****,
        "policy_name": "USB Device Policy",
        "policy_override": true,
        "quarantined": false,
        "registered_time": "2021-04-29T18:40:14.816Z",
        "scan_last_action_time": null,
        "scan_last_complete_time": null,
        "scan_status": null,
        "sensor_kit_type": "WINDOWS",
        "sensor_out_of_date": false,
        "sensor_pending_update": false,
        "sensor_states": [
            "ACTIVE",
            "LIVE_RESPONSE_NOT_RUNNING",
            "LIVE_RESPONSE_NOT_KILLED",
            "LIVE_RESPONSE_ENABLED",
            "SECURITY_CENTER_OPTLN_DISABLED"
        ],
        "sensor_version": "*.*.*.*",
        "status": "DEREGISTERED",
        "target_priority": "HIGH",
        "uninstall_code": "*****",
        "vcenter_host_url": *****,
        "vcenter_name": *****,
        "vcenter_uuid": *****,
        "vdi_base_device": *****,
        "virtual_machine": false,
        "virtualization_provider": "UNKNOWN",
        "vm_ip": *****,
        "vm_name": **********,
        "vm_uuid": null,
        "vulnerability_score": 0,
        "vulnerability_severity": null,
        "windows_platform": null
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "DeviceIDs": "\"[*****]\"",
    "DeviceNames": "\"[\\\"*****\\\"]\"",
    "LastInternalIPAddresses": "\"[\\\"***.***.***.***\\\"]\"",
    "LoginUserNames": "\"[\\\"***\\\\\\\\***\\\"]\"",
    "OSVersions": "\"[\\\"***\\\"]\"",
    "PolicyNames": "\"[\\\"USB Device Policy\\\",\\\"None\\\"]\"",
    "Quarantined": "\"[false]\"",
    "ScanStatuses": "\"[]\"",
    "ScanLastCompleteTimes": "\"[\\\"None\\\"]\"",
    "Statuses": "\"[\\\"DEREGISTERED\\\"]\"",
    "VulnerabilityScores": "\"[0.0]\"",
    "VulnerabilitySeverities": "\"[\\\"None\\\"]\""
}

Return Data

Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.

The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Device Info 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 VMware Carbon Black Cloud 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: error_code.

Error Sample Data

Get Device Info failed.

Status Code: 400.

Message: error_code.

Get Event Associated With Process

Retrieves events associated with the given process GUID.

Reader Note

Process Guid is a required parameter to run this command.
- Run the Get Processes command to obtain Process Guid. Process Guids can be found in the returned raw data at the path $.results[*].process_guid.
If an invalid process GUID is entered, the command will run successfully with no results.

Input

Input Parameter	Required/Optional	Description	Example
Process Guid	Required	The GUID of the process to retrieve associated events. Process Guid can be obtained using the Get Processes command.	7DE******************307

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "results": [
        {
            "backend_timestamp": "2021-05-07T23:37:08.685Z",
            "created_timestamp": "2021-05-26T22:20:12.286Z",
            "event_guid": "***************************************",
            "event_hash": "***************************************",
            "event_timestamp": "2021-05-07T23:35:49.712Z",
            "event_type": "regmod",
            "legacy": false,
            "process_guid": "***************************************",
            "process_pid": *****,
            "regmod_action": [
                "ACTION_DELETE_KEY"
            ],
            "regmod_name": "HKLM\\***\\***\\***\\***\\***\\***"
        },
        {
            "backend_timestamp": "2021-05-07T23:37:08.685Z",
            "created_timestamp": "2021-05-26T22:20:12.286Z",
            "event_guid": "***************************************",
            "event_hash": "***************************************",
            "event_timestamp": "2021-05-07T23:35:49.712Z",
            "event_type": "regmod",
            "legacy": false,
            "process_guid": "***************************************",
            "process_pid": *****,
            "regmod_action": [
                "ACTION_DELETE_KEY"
            ],
            "regmod_name": "HKLM\\***\\***\\***\\***\\***\\***"
        }
    ],
    "num_found": 200,
    "num_available": 200,
    "total_segments": 48,
    "processed_segments": 48
}

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.results in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "backend_timestamp": "2021-05-07T23:37:08.685Z",
        "created_timestamp": "2021-05-26T22:20:12.286Z",
        "event_guid": "***************************************",
        "event_hash": "***************************************",
        "event_timestamp": "2021-05-07T23:35:49.712Z",
        "event_type": "regmod",
        "legacy": false,
        "process_guid": "***************************************",
        "process_pid": *****,
        "regmod_action": [
            "ACTION_DELETE_KEY"
        ],
        "regmod_name": "HKLM\\***\\***\\***\\***\\***\\***\\***"
    },
    {
        "backend_timestamp": "2021-05-07T23:37:08.685Z",
        "created_timestamp": "2021-05-26T22:20:12.286Z",
        "event_guid": "***************************************",
        "event_hash": "***************************************",
        "event_timestamp": "2021-05-07T23:35:49.712Z",
        "event_type": "regmod",
        "legacy": false,
        "process_guid": "***************************************",
        "process_pid": *****,
        "regmod_action": [
            "ACTION_DELETE_KEY"
        ],
        "regmod_name": "HKLM\\***\\***\\***\\***\\***\\***"
    },
    {
        "backend_timestamp": "2021-05-07T23:26:51.483Z",
        "created_timestamp": "2021-05-26T22:20:12.316Z",
        "event_guid": "***************************************",
        "event_hash": "***************************************",
        "event_timestamp": "2021-05-07T23:25:50.14Z",
        "event_type": "netconn",
        "legacy": false,
        "netconn_action": "ACTION_CONNECTION_CREATE",
        "netconn_domain": "*****",
        "netconn_inbound": false,
        "netconn_local_ipv4": *****,
        "netconn_local_port": *****,
        "netconn_protocol": "*****",
        "netconn_remote_ipv4": *****,
        "netconn_remote_port": *****,
        "process_guid": "***************************************",
        "process_pid": *****
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "EventGuids": "\"[\\\"************\\\", \\\"************\\\", \\\"************\\\"]\"",
    "EventTypes": "\"[\\\"************\\\", \\\"************\\\", \\\"************\\\"]\"",
    "EventTimeStamps": "\"[\\\"2021-05-07T23:35:49.712Z\\\",\\\"2021-05-07T23:35:49.712Z\\\",\\\"2021-05-07T23:25:50.14Z\\\",\\\"2021-05-07T23:25:50.297Z\\\",\\\"2021-05-07T23:25:49.625Z\\\",\\\"2021-05-07T23:25:49.625Z\\\",\\\"2021-05-07T23:25:49.656Z\\\",\\\"2021-05-07T23:25:49.672Z\\\",\\\"2021-05-07T23:25:49.672Z\\\",\\\"2021-05-07T23:25:49.672Z\\\"]\""
}

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Event Associated With Process 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 VMware Carbon Black Cloud 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 is denied.

Error Sample Data

Get Event Associated With Process failed.

Status Code: 403.

Message: Access is denied.

Get Processes

Retrieves processes from VMware Carbon Black Cloud EDR.

Input

Input Parameter

Required/Optional

Description

Example

Last Hours

Optional

The timeframe, in hours, before the current time to filter search results.

24

Query

Optional

The query string to filter returned processes. For more information about the query syntax, refer to VMware's documentation.

process_hash:

925******************113

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "results": [
        {
            "backend_timestamp": "2021-06-27T20:18:35.538Z",
            "childproc_count": 0,
            "crossproc_count": 4,
            "device_group_id": *****,
            "device_id": *****,
            "device_name": "*****",
            "device_policy_id": *****,
            "device_timestamp": "2021-06-27T20:14:18.802Z",
            "filemod_count": 1,
            "ingress_time": 1624825076841,
            "modload_count": 21,
            "netconn_count": 0,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***.exe",
            "process_pid": [
                *****
            ],
            "process_start_time": "2021-06-27T20:08:18.681Z",
            "process_terminated": true,
            "process_username": [
                "***\\***"
            ],
            "regmod_count": 28,
            "scriptload_count": 0
        },
        {
            "backend_timestamp": "2021-06-27T20:26:23.828Z",
            "childproc_count": 0,
            "crossproc_count": 4,
            "device_group_id": *****,
            "device_id": *****,
            "device_name": "*****",
            "device_policy_id": *****,
            "device_timestamp": "2021-06-27T20:21:07.755Z",
            "filemod_count": 1,
            "ingress_time": 1624825567345,
            "modload_count": 21,
            "netconn_count": 0,
            "org_id": "*****",
            "parent_guid": "***************************************",
            "parent_pid": *****,
            "process_guid": "***************************************",
            "process_hash": [
                "***************************************",
                "***************************************"
            ],
            "process_name": "c:\\windows\\***\\***.exe",
            "process_pid": [
                *****
            ],
            "process_start_time": "2021-06-27T20:16:50.452Z",
            "process_terminated": true,
            "process_username": [
                "***\\***"
            ],
            "regmod_count": 28,
            "scriptload_count": 0
        }
    ],
    "num_found": 2184,
    "num_available": 161,
    "approximate_unaggregated": 2184,
    "num_aggregated": 606,
    "contacted": 5,
    "completed": 5
}

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.results in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "backend_timestamp": "2021-06-27T20:18:35.538Z",
        "childproc_count": 0,
        "crossproc_count": 4,
        "device_group_id": *****,
        "device_id": *****,
        "device_name": "*****",
        "device_policy_id": *****,
        "device_timestamp": "2021-06-27T20:14:18.802Z",
        "filemod_count": 1,
        "ingress_time": 1624825076841,
        "modload_count": 21,
        "netconn_count": 0,
        "org_id": "*****",
        "parent_guid": "***************************************",
        "parent_pid": *****,
        "process_guid": "***************************************",
        "process_hash": [
            "***************************************",
            "***************************************"
        ],
        "process_name": "c:\\windows\\***\\***.exe",
        "process_pid": [
            *****
        ],
        "process_start_time": "2021-06-27T20:08:18.681Z",
        "process_terminated": true,
        "process_username": [
            "***\\***"
        ],
        "regmod_count": 28,
        "scriptload_count": 0
    },
    {
        "backend_timestamp": "2021-06-27T20:26:23.828Z",
        "childproc_count": 0,
        "crossproc_count": 4,
        "device_group_id": ***,
        "device_id": *****,
        "device_name": "*****",
        "device_policy_id": *****,
        "device_timestamp": "2021-06-27T20:21:07.755Z",
        "filemod_count": 1,
        "ingress_time": 1624825567345,
        "modload_count": 21,
        "netconn_count": 0,
        "org_id": "*****",
        "parent_guid": "***************************************",
        "parent_pid": *****,
        "process_guid": "***************************************",
        "process_hash": [
            "***************************************",
            "***************************************"
        ],
        "process_name": "c:\\windows\\***\\***.exe",
        "process_pid": [
            *****
        ],
        "process_start_time": "2021-06-27T20:16:50.452Z",
        "process_terminated": true,
        "process_username": [
            "***\\***"
        ],
        "regmod_count": 28,
        "scriptload_count": 0
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "ProcessGuids": "\"[\\\"************\\\", \\\"************\\\"]\"",
    "ProcessNames": "\"[\\\"c:\\\\\\\\***\\\\\\\\***\\\\\\\\***.exe\\\",\\\"c:\\\\\\\\***\\\\\\\\***\\\\\\\\***.exe\\\"]\"",
    "ProcessSHA256Hashes": "\"[\\\"***************************************\\\",\\\"***************************************\\\"]\"",
    "DeviceIDs": "\"[*****,*****]\"",
    "DeviceNames": "\"[\\\"***\\\",\\\"***\\\"]\""
}

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Processes 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 VMware Carbon Black Cloud 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 value for parameter (Last Hours) is invalid.

Error Sample Data

Get Processes failed.

Status Code: 400.

Message: The value for parameter (Last Hours) is invalid.

Quarantine Host

Quarantines hosts associated with the given device IDs.

Reader Note

The parameter Hosts is required to run this command.

Run the Search Devices command to obtain Hosts. Hosts are Device IDs. Device IDs can be found in the returned raw data at the path $.results[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Hosts	Required	The IDs of the devices to quarantine. Host IDs can be obtained using the Search Devices command.	[************************]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    "",
    ""
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "hostID": *****,
        "result": "Successful"
    },
    {
        "hostID": *****,
        "result": "Successful"
    }
]

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

HOSTID	RESULT
3410694	Successful
3425787	Successful

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Quarantine Host 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 VMware Carbon Black Cloud 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: NOT_FOUND: org_id(s): 7DESJ9GN.

Error Sample Data

Quarantine Host failed.

Status Code: 404.

Message: NOT_FOUND: org_id(s): *****.

Search Alerts

Searches for alerts in VMware Carbon Black Cloud EDR.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Required	The start time of the time range to search alerts in UTC time.	2021-05-14 00:00
End Time	Required	The end time of the time range to search alerts in UTC time.	2021-05-21 00:00

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "num_found": 283222,
    "num_available": 10000,
    "results": [
        {
            "id": "***************************************",
            "legacy_alert_id": "***************************************",
            "org_key": "*****",
            "create_time": "2021-05-21T00:09:42.159Z",
            "last_update_time": "2021-05-21T00:09:42.159Z",
            "first_event_time": "2021-05-20T23:59:59.92Z",
            "last_event_time": "2021-05-20T23:59:59.92Z",
            "threat_id": "***************************************",
            "severity": 8,
            "category": "THREAT",
            "device_id": *****,
            "device_os": "WINDOWS",
            "device_os_version": null,
            "device_name": "***\\***",
            "device_username": "***@*****.com",
            "policy_id": *****,
            "policy_name": "Test Demo Defeeweewd3e",
            "target_value": "LOW",
            "workflow": {
                "state": "OPEN",
                "remediation": null,
                "last_update_time": "2021-05-21T00:09:03.832Z",
                "comment": null,
                "changed_by": "Carbon Black"
            },
            "notes_present": false,
            "tags": null,
            "reason": "Process ***.exe was detected by the report \"Processes NOT Listed and Not Signed\" in watchlist \"Splunk Watchlist\"",
            "count": 0,
            "report_id": "*****",
            "report_name": "Processes NOT Listed and Not Signed",
            "ioc_id": "***************************************",
            "ioc_field": null,
            "ioc_hit": "(process_reputation:NOT_LISTED AND NOT process_publisher_state:FILE_SIGNATURE_STATE_SIGNED)",
            "watchlists": [
                {
                    "id": "*****",
                    "name": "Splunk Watchlist"
                }
            ],
            "process_guid": "***************************************",
            "process_name": "*****.exe",
            "run_state": "RAN",
            "threat_indicators": [
                {
                    "process_name": "*****.exe",
                    "sha256": "***************************************",
                    "ttps": [
                        "***************************************"
                    ]
                }
            ],
            "threat_cause_actor_sha256": "***************************************",
            "threat_cause_actor_md5": "***************************************",
            "threat_cause_actor_name": "c:\\program files\\***//***//***//***.exe",
            "threat_cause_reputation": "NOT_LISTED",
            "threat_cause_threat_category": "UNKNOWN",
            "threat_cause_vector": "UNKNOWN",
            "document_guid": "***************************************",
            "type": "WATCHLIST"
        },
        {
            "id": "***************************************",
            "legacy_alert_id": "***************************************",
            "org_key": "*****",
            "create_time": "2021-05-21T00:04:31.091Z",
            "last_update_time": "2021-05-21T00:04:31.091Z",
            "first_event_time": "2021-05-20T23:59:51.326Z",
            "last_event_time": "2021-05-20T23:59:51.326Z",
            "threat_id": "***************************************",
            "severity": 8,
            "category": "THREAT",
            "device_id": *****,
            "device_os": "WINDOWS",
            "device_os_version": null,
            "device_name": "***\\***",
            "device_username": "***@*****.com",
            "policy_id": *****,
            "policy_name": "Test Demo Defeeweewd3e",
            "target_value": "LOW",
            "workflow": {
                "state": "OPEN",
                "remediation": null,
                "last_update_time": "2021-05-21T00:03:55.946Z",
                "comment": null,
                "changed_by": "Carbon Black"
            },
            "notes_present": false,
            "tags": null,
            "reason": "Process carpenter.cmd was detected by the report \"Processes NOT Listed and Not Signed\" in watchlist \"Splunk Watchlist\"",
            "count": 0,
            "report_id": "***************************************",
            "report_name": "Processes NOT Listed and Not Signed",
            "ioc_id": "***************************************",
            "ioc_field": null,
            "ioc_hit": "(process_reputation:NOT_LISTED AND NOT process_publisher_state:FILE_SIGNATURE_STATE_SIGNED)",
            "watchlists": [
                {
                    "id": "***************************************",
                    "name": "Splunk Watchlist"
                }
            ],
            "process_guid": "***************************************",
            "process_name": "***.cmd",
            "run_state": "RAN",
            "threat_indicators": [
                {
                    "process_name": "***.cmd",
                    "sha256": "***************************************",
                    "ttps": [
                        "***************************************"
                    ]
                }
            ],
            "threat_cause_actor_sha256": "***************************************",
            "threat_cause_actor_md5": "***************************************",
            "threat_cause_actor_name": "c:\\program files\\***\\***\\***\\***.cmd",
            "threat_cause_reputation": "NOT_LISTED",
            "threat_cause_threat_category": "UNKNOWN",
            "threat_cause_vector": "UNKNOWN",
            "document_guid": "***************************************",
            "type": "WATCHLIST"
        }
    ]
}

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.results in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "id": "***************************************",
        "legacy_alert_id": "***************************************",
        "org_key": "*****",
        "create_time": "2021-05-21T00:09:42.159Z",
        "last_update_time": "2021-05-21T00:09:42.159Z",
        "first_event_time": "2021-05-20T23:59:59.92Z",
        "last_event_time": "2021-05-20T23:59:59.92Z",
        "threat_id": "***************************************",
        "severity": 8,
        "category": "THREAT",
        "device_id": *****,
        "device_os": "*****",
        "device_os_version": null,
        "device_name": "***\\***",
        "device_username": "***@*****.com",
        "policy_id": *****,
        "policy_name": "Test Demo Defeeweewd3e",
        "target_value": "LOW",
        "workflow": {
            "state": "OPEN",
            "remediation": null,
            "last_update_time": "2021-05-21T00:09:03.832Z",
            "comment": null,
            "changed_by": "Carbon Black"
        },
        "notes_present": false,
        "tags": null,
        "reason": "Process ***.exe was detected by the report \"Processes NOT Listed and Not Signed\" in watchlist \"Splunk Watchlist\"",
        "count": 0,
        "report_id": "***************************************",
        "report_name": "Processes NOT Listed and Not Signed",
        "ioc_id": "***************************************",
        "ioc_field": null,
        "ioc_hit": "(process_reputation:NOT_LISTED AND NOT process_publisher_state:FILE_SIGNATURE_STATE_SIGNED)",
        "watchlists": [
            {
                "id": "***************************************",
                "name": "Splunk Watchlist"
            }
        ],
        "process_guid": "***************************************",
        "process_name": "***.exe",
        "run_state": "RAN",
        "threat_indicators": [
            {
                "process_name": "***.exe",
                "sha256": "***************************************",
                "ttps": [
                    "***************************************"
                ]
            }
        ],
        "threat_cause_actor_sha256": "***************************************",
        "threat_cause_actor_md5": "***************************************",
        "threat_cause_actor_name": "c:\\program files\\***\\***\\***\\***.exe",
        "threat_cause_reputation": "NOT_LISTED",
        "threat_cause_threat_category": "UNKNOWN",
        "threat_cause_vector": "UNKNOWN",
        "document_guid": "***************************************",
        "type": "WATCHLIST"
    },
    {
        "id": "***************************************",
        "legacy_alert_id": "***************************************",
        "org_key": "*****",
        "create_time": "2021-05-21T00:04:31.091Z",
        "last_update_time": "2021-05-21T00:04:31.091Z",
        "first_event_time": "2021-05-20T23:59:51.326Z",
        "last_event_time": "2021-05-20T23:59:51.326Z",
        "threat_id": "***************************************",
        "severity": 8,
        "category": "THREAT",
        "device_id": *****,
        "device_os": "*****",
        "device_os_version": null,
        "device_name": "***\\***",
        "device_username": "***@*****.com",
        "policy_id": *****,
        "policy_name": "Test Demo Defeeweewd3e",
        "target_value": "LOW",
        "workflow": {
            "state": "OPEN",
            "remediation": null,
            "last_update_time": "2021-05-21T00:03:55.946Z",
            "comment": null,
            "changed_by": "Carbon Black"
        },
        "notes_present": false,
        "tags": null,
        "reason": "Process carpenter.cmd was detected by the report \"Processes NOT Listed and Not Signed\" in watchlist \"Splunk Watchlist\"",
        "count": 0,
        "report_id": "*****",
        "report_name": "Processes NOT Listed and Not Signed",
        "ioc_id": "***************************************",
        "ioc_field": null,
        "ioc_hit": "(process_reputation:NOT_LISTED AND NOT process_publisher_state:FILE_SIGNATURE_STATE_SIGNED)",
        "watchlists": [
            {
                "id": "***************************************",
                "name": "Splunk Watchlist"
            }
        ],
        "process_guid": "***************************************",
        "process_name": "***.cmd",
        "run_state": "RAN",
        "threat_indicators": [
            {
                "process_name": "***.cmd",
                "sha256": "***************************************",
                "ttps": [
                    "***************************************"
                ]
            }
        ],
        "threat_cause_actor_sha256": "***************************************",
        "threat_cause_actor_md5": "***************************************",
        "threat_cause_actor_name": "c:\\program files\\***\\***\\***\\***\\***\\***.cmd",
        "threat_cause_reputation": "NOT_LISTED",
        "threat_cause_threat_category": "UNKNOWN",
        "threat_cause_vector": "UNKNOWN",
        "document_guid": "***************************************",
        "type": "WATCHLIST"
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

No sample data

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Search Alerts 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 VMware Carbon Black Cloud 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: There is no alerts found.

Error Sample Data

Search Alerts failed.

Status Code: 404.

Message: There is no alerts found.

Search Devices

Searches for devices in VMware Carbon Black Cloud EDR.

Input

Input Parameter	Required/Optional	Description	Example
Last Hours	Optional	The timeframe, in hours, before the current time to filter search results.	30
Status	Optional	The status of the device to filter search results.	REGISTERED
Limit	Optional	The maximum number of results to return.	2

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "results": [
            {
                "activation_code": null,
                "activation_code_expiry_time": "2017-11-07T20:39:37.55Z",
                "ad_group_id": *****,
                "appliance_name": *****,
                "appliance_uuid": *****,
                "av_ave_version": *****,
                "av_engine": null,
                "av_last_scan_time": null,
                "av_master": false,
                "av_pack_version": null,
                "av_product_version": null,
                "av_status": [
                    "AV_ACTIVE",
                    "ONDEMAND_SCAN_DISABLED"
                ],
                "av_update_servers": *****,
                "av_vdf_version": *****,
                "cluster_name": *****,
                "current_sensor_policy_name": "*****",
                "datacenter_name": *****,
                "deployment_type": "ENDPOINT",
                "deregistered_time": null,
                "device_meta_data_item_list": [
                    {
                        "key_name": "***",
                        "key_value": "***",
                        "position": 0
                    },
                    {
                        "key_name": "***",
                        "key_value": "DC=***,DC=***,DC=***",
                        "position": 0
                    },
                    {
                        "key_name": "***",
                        "key_value": "*.*.*",
                        "position": 0
                    }
                ],
                "device_owner_id": *****,
                "email": "Administrator",
                "esx_host_name": *****,
                "esx_host_uuid": *****,
                "first_name": *****,
                "id": *****,
                "last_contact_time": "2021-06-01T19:27:56.544Z",
                "last_device_policy_changed_time": "2021-05-31T13:48:13.736Z",
                "last_device_policy_requested_time": "2021-05-31T13:49:47.024Z",
                "last_external_ip_address": "***.***.***.***",
                "last_internal_ip_address": "***.***.***.***",
                "last_location": "OFFSITE",
                "last_name": *****,
                "last_policy_updated_time": "2021-05-26T16:26:08.391Z",
                "last_reported_time": "2021-05-26T02:12:53.839Z",
                "last_reset_time": null,
                "last_shutdown_time": null,
                "linux_kernel_version": *****,
                "login_user_name": "*****",
                "mac_address": "***************************************",
                "middle_name": null,
                "name": "***\\***",
                "organization_id": *****,
                "organization_name": "*****",
                "os": "*****",
                "os_version": "Windows Server 2016 x64",
                "passive_mode": false,
                "policy_id": *****,
                "policy_name": "*****",
                "policy_override": true,
                "quarantined": false,
                "registered_time": "2021-05-05T13:21:18.26Z",
                "scan_last_action_time": null,
                "scan_last_complete_time": null,
                "scan_status": null,
                "sensor_kit_type": "WINDOWS",
                "sensor_out_of_date": false,
                "sensor_pending_update": false,
                "sensor_states": [
                    "ACTIVE",
                    "LIVE_RESPONSE_NOT_RUNNING",
                    "LIVE_RESPONSE_NOT_KILLED",
                    "LIVE_RESPONSE_ENABLED",
                    "SECURITY_CENTER_OPTLN_DISABLED"
                ],
                "sensor_version": "*.*.*.*",
                "status": "REGISTERED",
                "target_priority": "LOW",
                "uninstall_code": "*****",
                "vcenter_host_url": *****,
                "vcenter_name": *****,
                "vcenter_uuid": *****,
                "vdi_base_device": *****,
                "virtual_machine": *****,
                "virtualization_provider": "UNKNOWN",
                "vm_ip": *****,
                "vm_name": *****,
                "vm_uuid": *****,
                "vulnerability_score": 0,
                "vulnerability_severity": null,
                "windows_platform": null
            },
            {
                "activation_code": "*****",
                "activation_code_expiry_time": "2021-03-24T06:06:18.79Z",
                "ad_group_id": *****,
                "appliance_name": *****,
                "appliance_uuid": *****,
                "av_ave_version": *****,
                "av_engine": null,
                "av_last_scan_time": null,
                "av_master": false,
                "av_pack_version": null,
                "av_product_version": null,
                "av_status": [
                    "AV_ACTIVE",
                    "ONDEMAND_SCAN_DISABLED"
                ],
                "av_update_servers": *****,
                "av_vdf_version": *****,
                "cluster_name": *****,
                "current_sensor_policy_name": "*****",
                "datacenter_name": *****,
                "deployment_type": "WORKLOAD",
                "deregistered_time": null,
                "device_meta_data_item_list": [
                    {
                        "key_name": "*****",
                        "key_value": "*****",
                        "position": 0
                    },
                    {
                        "key_name": *****",
                        "key_value": "DC=***,DC=***,DC=***,DC=***",
                        "position": 0
                    },
                    {
                        "key_name": "SUBNET",
                        "key_value": "*.*.*",
                        "position": 0
                    }
                ],
                "device_owner_id": *****,
                "email": "***@*****.com",
                "encoded_activation_code": "*****",
                "esx_host_name": null,
                "esx_host_uuid": null,
                "first_name": "Prashant",
                "id": *****,
                "last_contact_time": "2021-06-01T19:27:52.025Z",
                "last_device_policy_changed_time": "2021-05-30T12:29:59.601Z",
                "last_device_policy_requested_time": "2021-05-30T12:30:48.879Z",
                "last_external_ip_address": "***.***.***.***",
                "last_internal_ip_address": "***.***.***.***",
                "last_location": "OFFSITE",
                "last_name": "*****",
                "last_policy_updated_time": "2021-05-26T16:26:08.391Z",
                "last_reported_time": "2021-06-01T14:33:39.9Z",
                "last_reset_time": null,
                "last_shutdown_time": null,
                "linux_kernel_version": null,
                "login_user_name": "",
                "mac_address": "***************************************",
                "middle_name": null,
                "name": "***\\***",
                "organization_id": *****,
                "organization_name": "*****",
                "os": "WINDOWS",
                "os_version": "*****",
                "passive_mode": false,
                "policy_id": *****,
                "policy_name": "default",
                "policy_override": true,
                "quarantined": false,
                "registered_time": "2021-03-17T06:07:00.339Z",
                "scan_last_action_time": null,
                "scan_last_complete_time": null,
                "scan_status": null,
                "sensor_kit_type": "*****",
                "sensor_out_of_date": true,
                "sensor_pending_update": false,
                "sensor_states": [
                    "ACTIVE",
                    "LIVE_RESPONSE_NOT_RUNNING",
                    "LIVE_RESPONSE_NOT_KILLED",
                    "LIVE_RESPONSE_ENABLED",
                    "SECURITY_CENTER_OPTLN_DISABLED"
                ],
                "sensor_version": "*.*.*.*",
                "status": "REGISTERED",
                "target_priority": "LOW",
                "uninstall_code": "*****",
                "vcenter_host_url": *****,
                "vcenter_name": *****,
                "vcenter_uuid": *****,
                "vdi_base_device": *****,
                "virtual_machine": *****,
                "virtualization_provider": "VMW_ESX",
                "vm_ip": *****,
                "vm_name": *****,
                "vm_uuid": *****,
                "vulnerability_score": 10,
                "vulnerability_severity": "CRITICAL",
                "windows_platform": null
            }
        ],
        "num_found": 55
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.results in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "activation_code": *****,
        "activation_code_expiry_time": "2017-11-07T20:39:37.55Z",
        "ad_group_id": 0,
        "appliance_name": *****,
        "appliance_uuid": *****,
        "av_ave_version": *****,
        "av_engine": *****,
        "av_last_scan_time": null,
        "av_master": false,
        "av_pack_version": *****,
        "av_product_version": *****,
        "av_status": [
            "AV_ACTIVE",
            "ONDEMAND_SCAN_DISABLED"
        ],
        "av_update_servers": null,
        "av_vdf_version": *****,
        "cluster_name": *****,
        "current_sensor_policy_name": "*****",
        "datacenter_name": *****,
        "deployment_type": "ENDPOINT",
        "deregistered_time": null,
        "device_meta_data_item_list": [
            {
                "key_name": "*****",
                "key_value": "*****",
                "position": 0
            },
            {
                "key_name": "*****",
                "key_value": "DC=***,DC=***,DC=***",
                "position": 0
            },
            {
                "key_name": "*****",
                "key_value": "*.*.*",
                "position": 0
            }
        ],
        "device_owner_id": *****,
        "email": "Administrator",
        "esx_host_name": *****,
        "esx_host_uuid": *****,
        "first_name": *****,
        "id": *****,
        "last_contact_time": "2021-06-01T19:27:56.544Z",
        "last_device_policy_changed_time": "2021-05-31T13:48:13.736Z",
        "last_device_policy_requested_time": "2021-05-31T13:49:47.024Z",
        "last_external_ip_address": "***.***.***.***",
        "last_internal_ip_address": "***.***.***.***",
        "last_location": "OFFSITE",
        "last_name": *****,
        "last_policy_updated_time": "2021-05-26T16:26:08.391Z",
        "last_reported_time": "2021-05-26T02:12:53.839Z",
        "last_reset_time": null,
        "last_shutdown_time": null,
        "linux_kernel_version": *****,
        "login_user_name": "*****",
        "mac_address": "***************************************",
        "middle_name": null,
        "name": "***\\***",
        "organization_id": *****,
        "organization_name": "cb-internal-alliances.com",
        "os": "*****",
        "os_version": "*****",
        "passive_mode": false,
        "policy_id": *****,
        "policy_name": "*****",
        "policy_override": true,
        "quarantined": false,
        "registered_time": "2021-05-05T13:21:18.26Z",
        "scan_last_action_time": null,
        "scan_last_complete_time": null,
        "scan_status": null,
        "sensor_kit_type": "WINDOWS",
        "sensor_out_of_date": false,
        "sensor_pending_update": false,
        "sensor_states": [
            "ACTIVE",
            "LIVE_RESPONSE_NOT_RUNNING",
            "LIVE_RESPONSE_NOT_KILLED",
            "LIVE_RESPONSE_ENABLED",
            "SECURITY_CENTER_OPTLN_DISABLED"
        ],
        "sensor_version": "*.*.*.*",
        "status": "REGISTERED",
        "target_priority": "LOW",
        "uninstall_code": "*****",
        "vcenter_host_url": *****,
        "vcenter_name": *****,
        "vcenter_uuid": *****,
        "vdi_base_device": null,
        "virtual_machine": false,
        "virtualization_provider": "UNKNOWN",
        "vm_ip": *****,
        "vm_name": *****,
        "vm_uuid": *****,
        "vulnerability_score": 0,
        "vulnerability_severity": null,
        "windows_platform": null
    },
    {
        "activation_code": "*****",
        "activation_code_expiry_time": "2021-03-24T06:06:18.79Z",
        "ad_group_id": 0,
        "appliance_name": *****,
        "appliance_uuid": *****,
        "av_ave_version": *****,
        "av_engine": *****,
        "av_last_scan_time": null,
        "av_master": false,
        "av_pack_version": *****,
        "av_product_version": *****,
        "av_status": [
            "AV_ACTIVE",
            "ONDEMAND_SCAN_DISABLED"
        ],
        "av_update_servers": null,
        "av_vdf_version": *****,
        "cluster_name": *****,
        "current_sensor_policy_name": "*****",
        "datacenter_name": *****,
        "deployment_type": "WORKLOAD",
        "deregistered_time": null,
        "device_meta_data_item_list": [
            {
                "key_name": "*****",
                "key_value": "*****",
                "position": 0
            },
            {
                "key_name": "*****",
                "key_value": "DC=***,DC=***,DC=***,DC=***",
                "position": 0
            },
            {
                "key_name": "*****",
                "key_value": "*.*.*",
                "position": 0
            }
        ],
        "device_owner_id": *****,
        "email": "***@*****.com",
        "encoded_activation_code": "*****",
        "esx_host_name": null,
        "esx_host_uuid": null,
        "first_name": "*****",
        "id": *****,
        "last_contact_time": "2021-06-01T19:27:52.025Z",
        "last_device_policy_changed_time": "2021-05-30T12:29:59.601Z",
        "last_device_policy_requested_time": "2021-05-30T12:30:48.879Z",
        "last_external_ip_address": "***.***.***.***",
        "last_internal_ip_address": "***.***.***.***",
        "last_location": "OFFSITE",
        "last_name": "*****",
        "last_policy_updated_time": "2021-05-26T16:26:08.391Z",
        "last_reported_time": "2021-06-01T14:33:39.9Z",
        "last_reset_time": null,
        "last_shutdown_time": null,
        "linux_kernel_version": *****,
        "login_user_name": "*****",
        "mac_address": "***************************************",
        "middle_name": *****,
        "name": "***\\***",
        "organization_id": *****,
        "organization_name": "*****",
        "os": "*****",
        "os_version": "*****",
        "passive_mode": false,
        "policy_id": *****,
        "policy_name": "*****",
        "policy_override": true,
        "quarantined": false,
        "registered_time": "2021-03-17T06:07:00.339Z",
        "scan_last_action_time": null,
        "scan_last_complete_time": null,
        "scan_status": null,
        "sensor_kit_type": "WINDOWS",
        "sensor_out_of_date": true,
        "sensor_pending_update": false,
        "sensor_states": [
            "ACTIVE",
            "LIVE_RESPONSE_NOT_RUNNING",
            "LIVE_RESPONSE_NOT_KILLED",
            "LIVE_RESPONSE_ENABLED",
            "SECURITY_CENTER_OPTLN_DISABLED"
        ],
        "sensor_version": "***.***.***.***",
        "status": "REGISTERED",
        "target_priority": "LOW",
        "uninstall_code": "*****",
        "vcenter_host_url": *****,
        "vcenter_name": *****,
        "vcenter_uuid": *****,
        "vdi_base_device": *****,
        "virtual_machine": *****,
        "virtualization_provider": "VMW_ESX",
        "vm_ip": *****,
        "vm_name": *****,
        "vm_uuid": *****,
        "vulnerability_score": 10,
        "vulnerability_severity": "CRITICAL",
        "windows_platform": null
    }
]

Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

JSON

{
    "DeviceIds": "\"[*****,*****]\"",
    "DeviceNames": "\"[\\\"*****\\\\\\\\*****\\\",\\\"QA\\\\\\\\*****\\\"]\"",
    "LastInternalIPAddresses": "\"[\\\"***.***.***.***\\\",\\\"***.***.***.***\\\"]\"",
    "LoginUserNames": "\"[\\\"\\\",\\\"\\\"]\"",
    "OSVersions": "\"[\\\"*****\\\",\\\"*****\\\"]\"",
    "PolicyNames": "\"[\\\"*****\\\",\\\"*****\\\"]\"",
    "Statuses": "\"[\\\"REGISTERED\\\",\\\"REGISTERED\\\"]\""
}

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

No sample data

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Search Devices 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 VMware Carbon Black Cloud 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 value for parameter (Limit) is invalid.

Error Sample Data

Search Devices failed.

Status Code: 400.

Message: The value for parameter (Limit) is invalid.

Stop Background Scan

Stops a background scan on the given device IDs.

Reader Note

The parameter Device IDs is a required parameter to run this command.
- Run the Search Devices command to obtain Device IDs. Device IDs can be found in the returned raw data at the path $.results[*].id.
This command is not supported on devices with the Linux OS.

Input

Input Parameter	Required/Optional	Description	Example
Device IDs	Optional	The array of device IDs to stop the background scan. Device IDs can be obtained using the Search Devices command.	[************************]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "background_scan": false
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "background_scan": false
    }
]

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

DEVICE_ID	BACKGROUND_SCAN
*****       False

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Stop Background Scan 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 VMware Carbon Black Cloud 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: NOT_FOUND:device_id(s) : [*****].

Error Sample Data

Stop Background Scan failed.

Status Code: 404.

Message: NOT_FOUND:device_id(s) : [*****].

Unblock hashes

Unblocks SHA256 file hashes in VMware Carbon Black Cloud EDR.

Reader Note

Only previously blocked file hashes can be unblocked.

Input

Input Parameter	Required/Optional	Description	Example
Hashes	Optional	The array of SHA256 file hashes to unblock.	["**********************"]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "sha256_hash": "***************************************",
        "blocked": false
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "sha256_hash": "***************************************",
        "blocked": false
    }
]

Return Data

Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.

The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

SHA256_HASH	BLOCKED
***************************************   False

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Unblock hashes 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 VMware Carbon Black Cloud 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: could not find the relate id.

Error Sample Data

Unblock hashes failed.

Status Code: 400.

Message: could not find the relate id.

Unquarantine Host

Unquarantines hosts in VMware Carbon Black Cloud EDR.

Reader Note

The parameter Host IDs is required to run this command.

Run the Search Devices command to obtain Hosts. Hosts are Device IDs. Device IDs can be found in the returned raw data at the path $.results[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Host IDs	Required	The IDs of the devices to unquarantine. Host IDs can be obtained using the Search Devices command.	[************************]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "quarantined": false
    }
]

Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

JSON

[
    {
        "device_id": *****,
        "quarantined": false
    }
]

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:

A connection issue with the integration
The API returned an error message
No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE

Successful

Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE

DEVICE_ID	QUARANTINED
*****       False

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.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Unquarantine Host 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 VMware Carbon Black Cloud 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: NOT_FOUND: org_id(s): *****.

Error Sample Data

Unquarantine Host failed.

Status Code: 404.

Message: NOT_FOUND: org_id(s): *****.