Nucleus Security
LAST UPDATED: MAY 27, 2025
Overview
Nucleus Security is a platform designed to enhance vulnerability and exposure management for organizations. It unifies and operationalizes vulnerability data, enabling teams to prioritize and mitigate critical exposures efficiently.
D3 SOAR is providing REST operations to function with Nucleus Security.
Nucleus Security is available for use in:
Connection
To connect to Nucleus Security from D3 SOAR, follow this part to collect the required information below:
Parameter | Description | Example |
Nucleus API Server URL | The URL for the Nucleus API Server at the domain level. | https://nucleus-us1.nucleussec.com |
API Key | The key used for API authentication. | <API_KEY> |
Permission Requirements
Commands | Role | Permissions |
Fetch Event | API Account - General Users | API Access |
Get Asset Findings | API Account - General Users | API Access |
Get Asset Information | API Account - General Users | API Access |
Get Finding Details | API Account - General Users | API Access |
Get Project Scans | API Account - General Users | API Access |
Get Scan Finding Summary | API Account - General Users | API Access |
List Assets | API Account - General Users | API Access + Assets: View Assets |
List Mitigation Statuses | API Account - General Users | API Access |
List Projects | API Account - General Users | API Access |
List Project Scans | API Account - General Users | API Access |
List Teams | API Account - Project Admin | API Access + Teams: ViewTeams |
List Users | API Account - General Users | API Access |
Search Project Findings | API Account - General Users | API Access |
Test Connection | API Account - General Users | API Access |
Update Project Findings | API Account - General Users | API Access + Findings: Update Findings |
Configuring Nucleus Security to Work with D3 SOAR
READER NOTE
Users with API Access can create their own API key.
A user's API Key will remain valid unless they regenerate a new one or until the user is deleted/disabled.
Log into Nucleus Security.
For User Accounts
Navigate to User Profile.
Generate the API key, store it in a secure location, then click on the Save button.
-20250527-231230.png?inst-v=2f3d40f5-c7d4-4289-acc1-e1a4c9cf2145)
-20250527-231220.png?inst-v=2f3d40f5-c7d4-4289-acc1-e1a4c9cf2145)
For API Accounts
Navigate to Global Administration > Users.
Click on the </> Add API Account button.
Enter the API account username, then select the project.
Select a role, then click on the Create Account button.
Click on the
icon associated with the newly created API account.
Click on the Show API Key button, then store the API key in a secure location.
-20250527-230950.png?inst-v=2f3d40f5-c7d4-4289-acc1-e1a4c9cf2145)
-20250527-230942.png?inst-v=2f3d40f5-c7d4-4289-acc1-e1a4c9cf2145)
Configuring D3 SOAR to Work with Nucleus Security
Log in to D3 SOAR.
Find the Nucleus Security integration.
Navigate to Configuration on the top header menu.
Click on the Integration icon on the left sidebar.
Type Nucleus Security in the search box to find the integration, then click it to select it.
Click on the + Connection button on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Nucleus Security.
Connection Name: The desired name for the connection.
Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
Recipient site for events from connections Shared to Internal Sites: This field is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.
Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
Description (Optional): Add a description for the connection.
Tenant (Optional): When configuring the connection from a master tenant site, users have the option to choose the specific tenant sites to share the connection with. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.
Configure User Permissions: Defines which users have access to the connection.
Active: Check the checkbox to ensure the connection is available for use.
System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
1. Input the Nucleus API server URL.
2. Paste the API key obtained from the Nucleus Security platform (see step 3 for user accounts or step 7 for API accounts in the Configuring Nucleus Security to Work with D3 SOAR section).Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.
Connection Health Check: Periodically checks the connection status by scheduling the Test Connection command at the specified interval (in minutes). Available only for active connections, this feature also allows configuring email notifications for failed attempts.
Test the connection.
Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.
Click OK to close the alert window.
Click + Add to create and add the configured connection.
Commands
Nucleus Security includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command function, users can execute these commands independently for playbook troubleshooting.
Integration API Note
For more information about the Nucleus Security API, refer to the Nucleus Security API reference.
Note for Time-related parameters
The input format of time-related parameters may vary based on user account settings, which may cause the sample data in commands to differ from what is displayed. To adjust the time format, follow these steps:
Navigate to Configuration > Application Settings. Select Date/Time Format.
Choose the desired date and time format, then click on the Save button.
The selected time format will now be visible when configuring Date/Time command input parameters.
Fetch Event
Ingests project findings into VSOC platform as events. The returned findings are sorted by Finding ID in ascending order.
READER NOTE
Project ID is a required parameter to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The IDs of the projects from which findings are retrieved. Project IDs can be obtained using the List Projects command. |
JSON
|
Start Time | Optional | The start of the time range for retrieving findings (in UTC). Findings with a scan date after this time are returned. By default, the value is 24 hours before the End Time. | 12/20/2024 10:30 AM |
End Time | Optional | The end of the time range for retrieving findings (in UTC). Findings with a scan date before this time are returned. By default, the value is the current time. | 12/23/2024 07:23 PM |
Number of Event(s) Fetched | Optional | The maximum number of events returned per project. By default, all findings matching the criteria are returned. Valid values range from 1 to 1000. | 10 |
Mandiant Risk Ratings | Optional | Filters findings by Mandiant risk ratings. Available ratings are CRITICAL, HIGH, MEDIUM and LOW. By default, findings regardless of their risk rating will be returned. This parameter is ignored if both Mandiant Risk Ratings and Minimum EPSS Score parameters are provided. |
JSON
|
Finding CVEs | Optional | Filters findings by CVE IDs. Wildcard characters * or % may be used when supplying a single value. |
JSON
|
Finding Severities | Optional | The severities of the findings to filter. Available options include Critical, High, Medium, Low, and Informational. |
JSON
|
Minimum EPSS Score | Optional | The minimum EPSS score of the findings to filter. Findings with an EPSS score equal to or greater than this value will be returned. | 0.8 |
Additional Filters | Optional | Additional filters to refine the findings query. For available filter keys and syntax, refer to the Nucleus API documentation. |
JSON
|
Output
To view the sample output data for all commands, refer to this article.
Field Mapping
Fetch Event commands require event field mapping. Field mapping plays a key role for data normalization within the event pipeline. Field mapping converts the original data fields from the different providers to standardized D3 fields as defined by the D3 Model. Refer to Event and Incident Intake Field Mapping for details.
To add a custom field, click on the + Add Field button. Users can also remove built-in field mappings by clicking x. Note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.
As a system integration, the Nucleus Security integration has some pre-configured field mappings for default field mapping.
Default Event Source
The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, users will find a set of field mappings provided by the system. Default event source provides field mappings for common fields from the fetched data. The default event source has a "Main Event JSON Path" (i.e. $.Results) that is used to extract a batch of events from the response raw data. View the "Main Event JSON Path" by clicking on the Edit Main JSON Path button.

Main Event JSON Path: $.Results
The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks ([‘...’]) should be used to separate child elements in JSON arrays.
For example, the root node of a JSON Path is $.Results. The child node denoting the Unique Event Key field would be id. Putting it together, the JSON Path expression to extract the Unique Event Key is $.Results.id.
The pre-configured field mappings are detailed below:
Field Name | Source Field |
Analysis | .mandiant_analysis |
Asset ID | .asset_id |
Asset Name | .asset_name |
Assigned Teams | .justification_assigned_teams |
Assigned Users | .justification_assigned_users |
Date Date | .due_date |
EPSS Score | .epss_score |
Exploit Vectors | .mandiant_exploit_vectors |
Exploitation Consequence | .mandiant_exploitation_consequence |
Finding Justification Key | .finding_justification_key |
Finding Number | .finding_number |
Finding Output | .finding_output |
Finding Package | .finding_package |
Finding Path | .finding_path |
Finding Port | .finding_port |
Finding Recommendation | .finding_recommendation |
Finding References | .finding_references |
Finding Result | .finding_result |
IP Address | .ip_address |
Justification Text | .justification_text |
Justification Time | .justification_datetime |
Mitigations | .mandiant_mitigations |
Project ID | .ProjectID |
Risk Rating | .mandiant_risk_rating |
Scan ID | .scan_id |
Scan Type | .scan_type |
Vulnerable Products | .mandiant_vulnerable_products |
Unique Event Key | .finding_id |
Event name | .finding_name |
Start Time | .finding_discovered |
Description | .finding_description |
Severity | .finding_severity |
Status | .justification_status_name |
CVE | .finding_cve |
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Fetch Event failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data Fetch Event failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
Get Asset Findings
Returns the current findings for the specified assets in the project.
READER NOTE
Project ID and Asset IDs are required parameters to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Run the Fetch Event command to obtain the Asset IDs. Asset IDs can be found in the raw data at $.Results[*].asset_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to retrieve asset findings. Project ID can be obtained using the List Projects command. | ***** |
Asset IDs | Required | The IDs of the assets for which to retrieve findings. Asset IDs can be obtained using the Fetch Event command. |
JSON
|
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get Asset Findings 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data Get Asset Findings failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
Get Asset Information
Retrieves information about specific assets in a given project.
READER NOTE
Project ID and Asset IDs are required parameters to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Run the Fetch Event command to obtain the Asset IDs. Asset IDs can be found in the raw data at $.Results[*].asset_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to retrieve asset information. Project ID can be obtained using the List Projects command. | ***** |
Asset IDs | Required | The IDs of the assets for which to retrieve information. Asset IDs can be obtained using the Fetch Event command. |
JSON
|
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays 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 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 Asset Information 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data Get Asset Information failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
Get Finding Details
Retrieves details about specified findings and the affected hosts.
READER NOTE
Project ID, Finding Numbers, and Scan Type are required parameters to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Run the Search Project Findings command to obtain the Finding Numbers. Finding Numbers can be found in the raw data at $.Results[*].finding_number.
Run the Search Project Findings command to obtain the Scan Type. Scan Types can be found in the raw data at $.Results[*].scan_type.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to retrieve finding details. Project ID can be obtained using the List Projects command. | ***** |
Finding Numbers | Required | The numbers of the findings for which to retrieve details. Finding numbers can be obtained using the Search Project Findings or Fetch Event command. |
JSON
|
Scan Type | Required | The scan type of the findings. Scan type can be obtained using the Search Project Findings or Fetch Event command. | QUALYS |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays 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 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 Finding Details failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data Get Finding Details failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
Get Project Scans
Returns information on specific scans for the project.
READER NOTE
Project ID and Scan IDs are required parameters to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Run the List Project Scans command to obtain the Scan IDs. Scan IDs can be found in the raw data at $.Results[*].scan_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to retrieve scans. Project ID can be obtained using the List Projects command. | ***** |
Scan IDs | Required | The IDs of the scans. Scan IDs can be obtained using the List Project Scans command. |
JSON
|
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get Project Scans 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data Get Project Scans failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
Get Scan Finding Summary
Returns a list of all current findings in a given scan.
READER NOTE
Project ID and Scan ID are required parameters to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Run the List Project Scans command to obtain the Scan IDs. Scan IDs can be found in the raw data at $.Results[*].scan_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The project ID for obtaining the scan finding summary. The Project ID can be obtained using the List Projects command. | ***** |
Scan ID | Required | The scan ID for retrieving the finding summary. The Scan ID can be obtained using the List Project Scans command. | 0 |
Filter | Optional | Filters results based on string comparison of any field. Some properties accept filtering by an array of values. The exactMatch key determines whether to apply exact matching. When finding severity is unspecified in the filter, only findings of highest severity are returned. |
JSON
|
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get Scan Finding Summary 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data Get Scan Finding Summary failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
List Assets
Returns a list of assets filtered by the specified parameters within the given project.
READER NOTE
Project ID is a required parameter to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to retrieve assets. Project ID can be obtained using the List Projects command. | ***** |
Asset Name or IP | Optional | Filters assets by asset name or IP address. | ***.***.***.*** |
Asset Groups | Optional | Filters assets by asset groups. |
JSON
|
Asset Type | Optional | Filters assets by asset type. By default, assets are returned regardless of their type. | Host |
Unscanned Assets | Optional | Requests only unscanned assets when set to True, and only scanned assets when set to False. By default, both are returned. | True |
Assets with Findings | Optional | Requests only assets with findings when set to True, and only assets without findings when set to False. By default, both are returned. | True |
Inactive Assets | Optional | Requests only inactive assets when set to True, and only active assets when set to False. By default, both are returned. | True |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Assets 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data List Assets failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
List Mitigation Statuses
Returns a list of mitigation statuses available for updating a finding.
READER NOTE
Project ID is a required parameter to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to retrieve mitigation statuses. Project ID can be obtained using the List Projects command. | ***** |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Mitigation Statuses 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data List Mitigation Statuses failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
List Projects
Returns a list of all projects along with their current statuses.
Input
N/A
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Projects 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data List Projects failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
List Project Scans
Returns a list of scans for the specified project.
READER NOTE
Project ID is a required parameter to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to retrieve scans. Project ID can be obtained using the List Projects command. | ***** |
Output
To view the sample output data for all commands, refer to this article
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Project Scans 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data List Project Scans failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
List Teams
Returns a list of all teams within the specified project.
READER NOTE
Project ID is a required parameter to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to list teams. Project ID can be obtained using the List Projects command. | ***** |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Teams 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data List Teams failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
List Users
Returns a list of all users for a project.
READER NOTE
Project ID is a required parameter to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to list users. Project ID can be obtained using the List Projects command. | ***** |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | List Users 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data List Users failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
Search Project Findings
Returns a list of findings for the specified project.
READER NOTE
Project ID is a required parameter to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to retrieve findings. Project ID can be obtained using the List Projects command. | ***** |
Mandiant Risk Ratings | Optional | Filters findings by Mandiant risk ratings. Available ratings include CRITICAL, HIGH, MEDIUM, and LOW. By default, findings are returned regardless of risk rating. If both Mandiant Risk Ratings and Minimum EPSS Score parameters are provided, this parameter is ignored. |
JSON
|
Finding CVEs | Optional | Filters findings by CVE IDs. Wildcards * or % may be used if only one value is provided. |
JSON
|
Finding Severities | Optional | Filters findings by severities. Available severities include Critical, High, Medium, Low, and Informational. |
JSON
|
Minimum EPSS Score | Optional | Filters findings by minimum EPSS score. Findings with EPSS scores equal to or greater than this value are returned. | 9 |
Scan Date After | Optional | Returns findings with scan dates after the specified time. | 2025-01-01 00:00:00 |
Additional Filters | Optional | Supports additional filters for querying project findings. Refer to Nucleus API Docs for available filter options. |
JSON
|
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Search Project Findings 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data Search Project Findings failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
Update Project Findings
Updates the specified findings’ status, severity, assigned team, assigned user, due date, or comment. Updates apply to all specified Finding Numbers. At least one of Finding Severity, Finding Status, Team ID, User ID, Due Date, or Comment must be provided.
READER NOTE
Project ID, Finding Numbers, and Scan Type are required parameters to run this command.
Run the List Projects command to obtain the Project ID. Project IDs can be found in the raw data at $.Results[*].project_id.
Run the Search Project Findings command to obtain the Finding Numbers. Finding Numbers can be found in the raw data at $.Results[*].finding_number.
Run the Search Project Findings command to obtain the Scan Type. Scan Types can be found in the raw data at $.Results[*].scan_type.
Asset ID, Finding Justification Key, Finding Status, User ID and Team ID are optional parameters to run this command.
Run the Search Project Findings command to obtain the Asset ID and Finding Justification Key.
Asset IDs can be found in the raw data at $.Results[*].asset_id.
Finding Justification Keys can be found in the raw data at $.Results[*].finding_justification_key.
Run the List Mitigation Statuses command to obtain statuses for Finding Status. These statuses can be found in the raw data at $.Results[*].justification_status_name.
Run the List Users command to obtain the User ID. User IDs can be found in the raw data at $.Results[*].user_id.
Run the List Teams command to obtain the Team ID. Team IDs can be found in the raw data at $.Results[*].team_id.
Input
Input Parameter | Required/Optional | Description | Example |
Project ID | Required | The ID of the project from which to update findings. Project ID can be obtained using the List Projects command. | ***** |
Finding Numbers | Required | The finding numbers to update. Finding numbers can be obtained using the Search Project Findings command. |
JSON
|
ScanType | Required | The scan type of the findings. Scan Type can be obtained using the Search Project Findings command. All findings to be updated must share the same scan type. | QUALYS |
Asset ID | Optional | The Asset ID to which status, due date, and comment updates apply. Ignored for severity updates unless the instance severity feature is enabled. Asset ID can be obtained using the Search Project Findings command. By default, updates apply to all instances. Asset ID applies to all findings. Findings with different Asset IDs must be updated using separate command executions. | ***** |
Finding Justification Key | Optional | Required when updating specific asset values with Asset ID. Finding Justification Key can be obtained using the Search Project Findings command. | 8200*****f550 |
Finding Status | Optional | The new status of the findings. Statuses can be obtained using the List Mitigation Statuses command. | False Positive |
Due Date | Optional | The due date for the findings in YYYY-MM-DD format. If Asset ID and Finding Justification Key are omitted, all instances receive the update. If both are provided, only the matching instance is updated. Use 'N/A' to remove the due date. | 2025-02-28 |
Finding Severity | Optional | The new severity of the findings. If instance level severity is disabled, Asset ID and Finding Justification Key are ignored and update applies to unique findings. | Critical |
Comment | Optional | A comment added to the findings. | Test comment |
Severity Update Comment | Optional | The comment added when updating the severity of the findings. Used only for severity updates. | Severity Update test comment |
User ID | Optional | The ID of the user to whom the findings are assigned. User ID can be obtained using the List Users command. | ***** |
Team ID | Optional | The ID of the team to which the findings are assigned. Team ID can be obtained using the List Teams command. Enter 'N/A' to unassign the team. | ***** |
Output
To view the sample output data for all commands, refer to this article.
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Update Project Findings 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 Nucleus Security 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: You must have a valid Support account to call this API. |
Error Sample Data Update Project Findings failed. Status Code: 403. Message: You must have a valid Support account to call this API. |
Test Connection
Allows users to perform a health check on an integration connection. Users can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.
Input
N/A
Output
Output Type | Description | Return Data Type |
Return Data | Indicates one of the possible command execution states: Successful or Failed. The Failed state can be triggered by any of the following errors: A connection issue with the integration The API returned an error message No response from the API More details about an error can be viewed in the Error tab. | String |
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Test Connection failed. Failed to check the connector. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Nucleus Security 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: You must have a valid support account to call this API. |
Error Sample Data Test Connection failed. Failed to check the connector. Status Code: 403. Message: You must have a valid Support account to call this API |