Stamus Clear NDR

LAST UPDATED: MAY 22, 2025

Overview

Stamus Clear NDR is a Network Detection and Response (NDR) platform developed by Stamus Networks. It provides advanced threat detection, network visibility, and response capabilities using deep packet inspection (DPI), threat intelligence, and behavioral analysis.

D3 SOAR is providing REST operations to function with Stamus Clear NDR.

Stamus Clear NDR is available for use in:

Connection

To connect to Stamus Clear NDR from D3 SOAR, follow this part to collect the required information below:

Configuring Stamus Clear NDR to Work with D3 SOAR

1. Log into Stamus Clear NDR.

   

2. Navigate to the token list.

   

   1. Click the user icon.

   2. Select the Account settings option.

   3. Click the Token list link.

3. Click the Add token link.

   

4. Create the token.
   

   

   1. Name the token.

   2. Enter a description.

   3. Ensure that the Active checkbox is selected.

   4. Enter a role name.

   5. Select the permission scopes as necessary to define the token’s access level.
      Refer to the Reader Note for further information.

   6. Click the Valid button to create the token.

5. Copy the token. Refer to step 3i sub-step 2 in Configuring D3 SOAR to Work with Stamus Clear NDR.

   

READER NOTE

Only users assigned the Superuser role can view the complete set of permission scopes.

Configuring D3 SOAR to Work with Stamus Clear NDR

1. Log in to D3 SOAR.

2. Find the Stamus Clear NDR integration.

   

   1. Navigate to Configuration on the top header menu.

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

   3. Type Stamus Clear NDR in the search box to find the integration, then click it to select it.

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

3. Configure the following fields to create a connection to Stamus Clear NDR.

   

   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 is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.

   4. Agent Name (Optional): 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 a description for the connection.

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

   7. Active: Check the checkbox to ensure the connection is available for use.

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

   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.

      2. Copy the Token from the Stamus Clear NDR platform. Refer to step 5 of Configuring Stamus Clear NDR to Work with D3 SOAR.

      3. Input the Tenant ID if multi-tenancy is enabled.

   10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.

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

4. Test the connection.

   

   1. Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.

   2. Click OK to close the alert window.

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

Commands

Stamus Clear NDR 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 Stamus Clear NDR API, refer to the Stamus Clear NDR 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:

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

   

2. Choose the desired date and time format, then click on the Save button.

   

The selected time format will now be visible when configuring Date/Time command input parameters.

Fetch Event

Ingests Hunting Events or NTA/NSM Events. For multi-tenant SCS instances, only Hunting Events or NTA/NSM events from the tenant ID specified in the connection parameter will be ingested.

Input

Output

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

Fetch Event Field Mapping

Fetch Event commands require event field mapping. Field mapping plays a key role for data normalization within the event pipeline. Field mapping converts the original data fields from the different providers to standardized D3 fields as defined by the D3 Model. Refer to Event and Incident Intake Field Mapping for details.

To add a custom field, click on the + Add Field button. Users can also remove built-in field mappings by clicking x. Note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.

• Default Event Source
  The D3 system configures the field mapping for the fields which are common for Hunting Events and NTA/NSE Events. The default event source has a "Main Event JSON Path" (i.e., $.results) that is used to extract a batch of events from the response raw data. Click Edit 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.

As a system integration, the Stamus Clear NDR integration has some pre-configured field mappings.

• NTANSMEvent Event Source

  

  The D3 system configures the field mappings which are specific to the NTA/NTSM Event-related events (eg. Tag and Hostname). If a source field in the field mapping is not found, the corresponding field mapping will be ignored. Because the EventSource field in the raw data for NTA/NTSM Events consistently has the value NTANSMEvent, these events can be identified by the Search String: {$.EventSource}=NTANSMEvent. Click Edit Event Source to view the Search String.

• Hunting Event Source

  

  The D3 system configures the field mappings which are specific to Hunting Events (e.g., Source IP Address and Destination IP Address). If a source field in the field mapping is not found, the corresponding field mapping will be ignored. Because the EventSource field in the raw data for Hunting Events consistently has the value HuntingEvent, these events can be identified by the Search String: {$.EventSource}=HuntingEvent. Click Edit Event Source to view the Search String.

The pre-configured field mappings are detailed below:

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.

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

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.