ExtraHop Reveal(x) v2

LAST UPDATED: 03/12/2024

Overview

ExtraHop Reveal(x) uses wire data and artificial intelligence to analyze the behavior that impacts critical assets.

D3 SOAR is providing REST operations to function with ExtraHop Reveal(x).

ExtraHop Reveal(x) v2 is available for use in:

Connection

To connect to ExtraHop Reveal(x) v2 from D3 SOAR, please follow this part to collect the required information below:

Configuring ExtraHop Reveal(x) to Work with D3 SOAR

1. Ensure that API key generation is allowed on the ExtraHop system. This setting is controlled by administrators or users with unlimited privileges.

2. Log in to the ExtraHop system's Administration settings by visiting https://<extrahop-hostname-or-IP-address>/admin.

3. Navigate to the Access Settings section and click on API Access.

4. In the Manage API Access section, choose one of the following options:

   1. Allow all users to generate an API key: This allows both local and remote users to generate API keys.

   2. Only allow local users to generate an API key: Remote users are not able to generate API keys.

   3. Disallow all users from generating an API key: No API keys can be generated by any user.

5. Click on the Save Settings button to save your changes.

6. Navigate back to the Access Settings section and click on API Access.

7. In the Generate an API Key section, enter a description for the new key and click Generate.

8. Scroll down to the API Keys section and locate the API key that matches your description. Copy the key for later use.

Configuring D3 SOAR to Work with ExtraHop Reveal(x) v2

1. Log in to D3 SOAR.

2. Find the ExtraHop Reveal(x) v2 integration.

   

   1. Navigate to Configuration on the top header menu.

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

   3. Type ExtraHop Reveal(x) v2 in the search box to find the integration, then click it to select it.

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

3. Configure the following fields to create a connection to ExtraHop Reveal(x) v2.

   

   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. Configure User Permissions: Defines which users have access to the connection.

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

      

   8. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
      1. Input your Server URL.
      2. Input your API Key.
      3. Input your API Version.

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

   10. Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.

       To set up a connection health check, check the Connection Health Check tickbox. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.

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

ExtraHop Reveal(x) 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 ExtraHop Reveal(x) API, please refer to the ExtraHop Reveal(x) API reference.

Fetch Events

Retrieves detections that have been identified by the ExtraHop system.

Input

Output

[
    {
        "appliance_id": *,
        "assignee": "string",
        "categories": [
            "string"
        ],
        "description": "string",
        "end_time": 0,
        "id": *,
        "is_user_created": true,
        "mitre_tactics": [],
        "mitre_techniques": [],
        "participants": [],
        "properties": {},
        "resolution": "string",
        "risk_score": 0,
        "start_time": 0,
        "status": "string",
        "ticket_id": "string",
        "ticket_url": "string",
        "title": "******",
        "type": "string",
        "update_time": 0
    }
]

Successful

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 may also remove built-in field mappings by clicking x. Please note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.

As a system integration, the ExtraHop Reveal(x) integration has some pre-configured field mappings for default field mapping.

• Default Event Source
  The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched events . The default event source has a “Main Event JSON Path” (i.e., $) 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: $
    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 $. The child node denoting the Unique Event Key field would be .id. Putting it together, the JSON Path expression to extract the Unique Event is $.id.

The pre-configured field mappings are detailed below:

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Get Alerts

Retrieves all alerts.

Input

N/A

Output

No Sample Data

No Sample Data

No Sample Data

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.

Get Device by ID

Retrieves a device of the given Device ID.

Input

Output

No Sample Data

No Sample Data

No Sample Data

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.

Get Watchlist

Retrieves all devices that are on the watchlist.

Input

N/A

Output

No Sample Data

No Sample Data

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.

Test Connection

Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

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.