Skip to main content
Skip table of contents

ExtraHop Reveal(x) v2

LAST UPDATED: OCT 16, 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:

D3 SOAR

V14.0.26.0+

Category

Network Security

Deployment Options

Option II, Option IV

Connection

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

Parameter

Description

Example

Server URL

The server URL for the API connection.

https://example.com/api/

API Key

The API key to authenticate the API connection.

*******

API Version

The version of the API to use for the connection.

V1

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.

    Group 1 (2).png
    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.

    Group 5 (2).png
    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.

      Group 6 (3).png
    9. 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.

    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.

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

  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

Input Parameter

Required/Optional

Description

Example

Start Time

Required

The start time of the time range for fetching detections, specified in UTC.

If Create Time is selected as the Query Time Field, this command retrieves detections created after the specified date. For sensors, it returns detections generated after the specified date. For consoles, it returns detections first synchronized to the console after the specified date. 

If Update Time is selected as the Query Time Field, this command retrieves detections related to events that occurred after the specified date. 

The ExtraHop Machine Learning Service analyzes historical data to generate detections, resulting in a delay between when the events that cause those detections occur and when the detections are generated. 

If detections are searched within the same update_time window multiple times, a later search may return detections that were not included in an earlier search.

2023-02-25 00:00

End Time

Optional

The end time of the time range for fetching detections is specified in UTC.

If Create Time is selected as the Query Time Field, this command retrieves detections created before the specified date.

If Update Time is selected as the Query Time Field, it returns detections related to events that occurred before the specified date.

By default, the end time is the current time. 

2023-02-26 00:00

Query Time Field

Optional

The time field used to query detections with the specified Start Time and End Time. Available options are:

  • Create Time

  • Update Time

By default, the value is set to Create Time.

Create Time

Number of Event(s) Fetched

Optional

The maximum number of detections to return. The available range is between 1 and 100.

By default, all detections that meet the criteria set by the other parameters will be returned.

10

Filter

Optional

The search parameters used to filter detections. Refer to ExtraHop REST API Guide for filter details.

{"categories": ["sec"] } 

Tolerance Scope

Optional

A buffer time (in minutes) applied to the query to ensure events are fetched between the specified start and end time, without loss or fetch failure.

Events will be fetched between the adjusted range of {Start Time - Tolerance Scope, End Time}.

5

Output

Return Data

Indicates one of the possible command execution states: Successful, Successful with No Event Data 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
Raw Data

The primary response data from the API request.

Note: The provided sample data only provides the structure of the response data and does not include any actual sample values.

SAMPLE DATA

JSON
[
    {
        "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
    }
]
Result

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

SAMPLE DATA

Start Time (UTC)

2021-01-01 00:00:00

End Time (UTC)

2022-01-01 00:00:00

Events Count

1

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

    Frame 24 (9)-20241016-192353.png
    • 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 Document ID field would be .id. Putting it together, the JSON Path expression to extract the Document ID is $.id.

The pre-configured field mappings are detailed below:

Field Name

Source Field

Document ID

.id

Description

.description

Tactics

.mitre_tactics

Techniques

.mitre_techniques

Resolution

.resolution

Event Type

.type

Webhook Extrainfo

.webhookExtraInfo

Event name

.title

Event category

.categories

Start Time

.start_time

Status

.status

Update Time

.update_time

Risk Score

.risk

Assignee

.assignee

Ticket ID

.ticket_id

Device ID

.participants[?(@.object_type=='device')].object_id

Device Role

.participants[?(@.object_type=='device')].role

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 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 ExtraHop Reveal(x) 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: Invalid URL.

Error Sample Data

Fetch Events failed.

Status Code: 401.

Message: Invalid URL.

Get Alerts

Retrieves all alerts.

Input

N/A

Output

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
Raw Data

The primary response data from the API request.

Note: The provided sample data only provides the structure of the response data and does not include any actual sample values.

SAMPLE DATA

JSON
[
    {
        "apply_all": true,
        "author": "string",
        "categories": [
            "string"
        ],
        "cc": [],
        "description": "string",
        "disabled": true,
        "field_name": "string",
        "field_name2": "string",
        "field_op": "string",
        "id": *****,
        "interval_length": 0,
        "mod_time": 0,
        "name": "string",
        "notify_snmp": true,
        "object_type": "string",
        "operand": "string",
        "operator": "string",
        "param": {},
        "param2": {},
        "protocols": [
            "string"
        ],
        "refire_interval": 0,
        "severity": 0,
        "stat_name": "string",
        "type": "string",
        "units": "string"
    }
]
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.

Note: No sample data is provided for the key fields in this integration.

SAMPLE DATA

JSON
{
    "AlertIDs": [ 0 ],
    "AlertTypes": [ "string" ],
    "Severities": [ 0 ],
    "Descriptions": [ "string" ],
    "Disabled": [ true ]
}
Result

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

SAMPLE DATA

Alerts Count

0

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 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 ExtraHop Reveal(x) 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: Invalid URL.

Error Sample Data

Get Alerts failed.

Status Code: 401.

Message: Invalid URL.

Get Device by ID

Retrieves a device of the given Device ID.

Input

Input Parameter

Required/Optional

Description

Example

Device ID

Required

The ID of the device to return. The Device ID is a unique identifier for a device, which is displayed as the API ID on the device page in the ExtraHop system.

0

Output

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
Raw Data

The primary response data from the API request.

Note: The provided sample data only provides the structure of the response data and does not include any actual sample values.

SAMPLE DATA

JSON
{
    "activity": [],
    "analysis": "string",
    "analysis_level": 0,
    "auto_role": "string",
    "cdp_name": "string",
    "cloud_account": "string",
    "cloud_instance_description": "string",
    "cloud_instance_id": "string",
    "cloud_instance_name": "string",
    "cloud_instance_type": "string",
    "critical": true,
    "custom_criticality": "string",
    "custom_make": "string",
    "custom_model": "string",
    "custom_name": "string",
    "custom_type": "string",
    "default_name": "string",
    "description": "string",
    "device_class": "string",
    "dhcp_name": "string",
    "discover_time": 0,
    "discovery_id": "string",
    "display_name": "string",
    "dns_name": "string",
    "extrahop_id": "string",
    "id": *****,
    "ipaddr4": "string",
    "ipaddr6": "string",
    "is_l3": true,
    "last_seen_time": 0,
    "macaddr": "string",
    "mod_time": 0,
    "model": "string",
    "model_override": "string",
    "netbios_name": "string",
    "node_id": *****,
    "on_watchlist": true,
    "parent_id": *****,
    "role": "string",
    "subnet_id": "string",
    "user_mod_time": 0,
    "vendor": "string",
    "vlanid": *****,
    "vpc_id": "string"
}
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.

Note: No sample data is provided for the key fields in this integration.

SAMPLE DATA

JSON
{
    "DeviceID": *****,
    "DisplayName": "string",
    "ExtrahopID": "string",
    "MACAddress": "string"
}
Result

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

SAMPLE DATA

id

*****

ipaddr4

string

default_name

string

description

string

display_name

string"

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 Device 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 ExtraHop Reveal(x) 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: Invalid URL.

Error Sample Data

Get Device by ID failed.

Status Code: 401.

Message: Invalid URL.

Get Watchlist

Retrieves all devices that are on the watchlist.

Input

N/A

Output

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
Raw Data

The primary response data from the API request.

Note: No sample data is available for this integration.

SAMPLE DATA

JSON
[
    {
        "activity": [],
        "analysis": "string",
        "analysis_level": 0,
        "auto_role": "string",
        "cdp_name": "string",
        "cloud_account": "string",
        "cloud_instance_description": "string",
        "cloud_instance_id": "string",
        "cloud_instance_name": "string",
        "cloud_instance_type": "string",
        "critical": true,
        "custom_criticality": "string",
        "custom_make": "string",
        "custom_model": "string",
        "custom_name": "string",
        "custom_type": "string",
        "default_name": "string",
        "description": "string",
        "device_class": "string",
        "dhcp_name": "string",
        "discover_time": 0,
        "discovery_id": "string",
        "display_name": "string",
        "dns_name": "string",
        "extrahop_id": "string",
        "id": *****,
        "ipaddr4": "string",
        "ipaddr6": "string",
        "is_l3": true,
        "last_seen_time": 0,
        "macaddr": "string",
        "mod_time": 0,
        "model": "string",
        "model_override": "string",
        "netbios_name": "string",
        "node_id": *****,
        "on_watchlist": true,
        "parent_id": *****,
        "role": "string",
        "subnet_id": "string",
        "user_mod_time": 0,
        "vendor": "string",
        "vlanid": 0,
        "vpc_id": "string"
    }
]
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": [ ***** ]
}
Result

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

SAMPLE DATA

WatchList Devices Count

0

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 Watchlist 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 ExtraHop Reveal(x) 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: Invalid URL.

Error Sample Data

Get Watchlist failed.

Status Code: 401.

Message: Invalid URL.

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

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.

SAMPLE DATA

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

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 ExtraHop Reveal(x) 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: Invalid URL.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 401.

Message: Invalid URL.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.