Devo Alerts

Overview

Devo SIEM is a cloud-based data logging and security analytics platform designed to improve access to security data across an enterprise. Security teams have access to real-time and historical data to quickly respond to their organization's threat landscape. This integration allows organizations to query and manage alerts as well as other data sources.

D3 SOAR is providing REST operations to function with Devo Alerts.

Devo Alerts is available for use in:

D3 SOAR	V16.1.13.0+
Category	SIEM & XDR
Deployment Options	Option II, Option IV

Connection

To connect to Devo Alerts from D3 SOAR, please follow this part to collect the required information below:

Parameter	Description	Example
Server URL	The server URL of the Devo Alerts API.	https://api-us.devo.com
Stand Alone Token	The stand alone token for authentication.	16a1****************f239
API Version	The version of the API to use for the connection.	v1

Configuring Devo Alerts to Work with D3 SOAR

Generating Authentication Tokens

Refer to Authentication tokens from Devo's documentation for instructions on generating authentication tokens. A token is required to establish the integration connection in D3 SOAR.

Authorizing Alerts API Requests

Refer to Authorizing Alerts API requests from Devo's documentation for instructions on authorizing access for the Alerts API.

When utilizing API access through an authorized token, the tasks you are allowed to perform are determined by the role permissions assigned to your account in Devo. To understand the specific role permissions required for different types of requests, please refer to the Working with the Alerts API documentation.

Once the token is generated, it can be found in the table. Click its name and copy the token value from the details window that appears.

Configuring D3 SOAR to Work with Devo Alerts

Log in to D3 SOAR.
Find the Devo Alerts integration.
1. Navigate to Configuration on the top header menu.
2. Click on the Integration icon on the left sidebar.
3. Type Devo Alerts 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 Devo Alerts.
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. The default value is https://api-us.devo.com.
  2. Copy the Stand Alone Token from the Devo Alerts platform. Refer to Configuring Devo Alerts to Work with D3 SOAR.
  3. Input the API Version. The default value is v1.
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.
11. 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.
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

Devo Alerts 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 Devo Alerts API, please refer to the Devo Alerts API reference.

Reader Note

Certain permissions are required for each command. Please refer to Authorizing Alerts API Requests and Configuring Devo Alerts 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.

Add Comment To Alerts

Adds an annotation to the specified triggered alerts.

Reader Note

The parameter Alert IDs is required to run this command.

You should already have your desired Alert IDs on hand to run this command. If you don’t, you can use the Fetch Event command with defined filters to retrieve the desired Alert IDs. The Alert IDs can be found in the raw data at the path $[*].id.

The parameter Reply To Comment IDs is optional to run this command.

If you set the Comment Type parameter as Reply, the Reply To Comment IDs parameter is required.
Run the Get Alert Details command to obtain Reply To Comment IDs. Reply To Comment IDs can be found from the returned raw data at the path $[*].commentsList[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Alert IDs	Required	The IDs of the alerts to add the annotation. Alert IDs can be obtained using the Fetch Event command.	["*","*"]
Comment Type	Required	The annotation type is indicated by the following options: Alert: Create a new annotation for an alert. Reply: Respond to an existing annotation. Note: If you wish to reply to an existing annotation, please provide the corresponding Comment IDs in the "Reply To Comment IDs" parameter.	ALERT
Comment Title	Optional	The title of the annotation.	testAnnotation
Comment Message	Required	The message content of the annotation.	From alerts API, test comments d3lab
Reply To Comment IDs	Optional	The ID of the comment to reply to. Comment IDs can be obtained using the Get Alert Details command. This parameter is not required if you are adding a new comment.	[ "***" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "results": [
        {
            "idAlert": ***,
            "comments": [
                {
                    "id": ***,
                    "author": {
                        "id": **,
                        "user": {
                            "id": "***-***-***-***-***",
                            "email": "test@example.com",
                            "username": "test example",
                            "telephone": "",
                            "pwd": "**************",
                            "status": 0,
                            "validation_token": "**************",
                            "defaultDomain": null,
                            "updateDate": 1681299881000,
                            "creationDate": 1659456133000,
                            "otpSecret": "**************",
                            "loginAttempts": 0,
                            "recoveryAttempts": 0
                        },
                        "domain": {
                            "id": "***-***-***-***-***",
                            "name": "partner_domain",
                            "status": 0,
                            "type": 11,
                            "updateDate": 1679684818000,
                            "creationDate": 1639577548000,
                            "subscribed": 0,
                            "daysLeft": 30,
                            "showLanding": true,
                            "reseller": null,
                            "groupId": null,
                            "alertsLastReseted": 1679684818000,
                            "authRestrictions": false
                        },
                        "lastTimeLogged": 1673260105000,
                        "status": 0,
                        "creationDate": 1640279609000,
                        "updateDate": 1673260105000,
                        "pwd": "**************",
                        "validationToken": "**************",
                        "roleCustom": null,
                        "rolesCustom": null,
                        "externalId": null,
                        "owner": true,
                        "alertsLastVisited": ***
                    },
                    "msg": "From alerts API, test comments d3lab",
                    "ack": "{\"ackUserList\":[\"***-***-***-***-***\"]}",
                    "creationDate": 1681936387000,
                    "updateDate": 1681936387000,
                    "elementType": "alert",
                    "elementId": "***",
                    "domain": {
                        "id": "***-***-***-***-***",
                        "name": "partner_domain",
                        "status": 0,
                        "type": 11,
                        "updateDate": 1679684818000,
                        "creationDate": 1639577548000,
                        "subscribed": 0,
                        "daysLeft": 30,
                        "showLanding": true,
                        "reseller": null,
                        "groupId": null,
                        "alertsLastReseted": 1679684818000,
                        "authRestrictions": false
                    },
                    "title": "testAnnotation",
                    "status": null,
                    "task": false
                },
                {
                    "id": ***,
                    "author": {
                        "id": ***,
                        "user": {
                            "id": "***-***-***-***-***",
                            "email": "test@example.com",
                            "username": "test example",
                            "telephone": "",
                            "pwd": "**************",
                            "status": 0,
                            "validation_token": "**************",
                            "defaultDomain": null,
                            "updateDate": 1681299881000,
                            "creationDate": 1659456133000,
                            "otpSecret": "**************",
                            "loginAttempts": 0,
                            "recoveryAttempts": 0
                        },
                        "domain": {
                            "id": "***-***-***-***-***",
                            "name": "partner_domain",
                            "status": 0,
                            "type": 11,
                            "updateDate": 1679684818000,
                            "creationDate": 1639577548000,
                            "subscribed": 0,
                            "daysLeft": 30,
                            "showLanding": true,
                            "reseller": null,
                            "groupId": null,
                            "alertsLastReseted": 1679684818000,
                            "authRestrictions": false
                        },
                        "lastTimeLogged": 1673260105000,
                        "status": 0,
                        "creationDate": 1640279609000,
                        "updateDate": 1673260105000,
                        "pwd": "**************",
                        "validationToken": "**************",
                        "roleCustom": null,
                        "rolesCustom": null,
                        "externalId": null,
                        "owner": true,
                        "alertsLastVisited": 1662488300000
                    },
                    "msg": "From alerts API, test comments d3lab",
                    "ack": "{\"ackUserList\":[\"***-***-***-***-***\"]}",
                    "creationDate": 1681936383000,
                    "updateDate": 1681936383000,
                    "elementType": "alert",
                    "elementId": "***",
                    "domain": {
                        "id": "***-***-***-***-***",
                        "name": "partner_domain",
                        "status": 0,
                        "type": 11,
                        "updateDate": 1679684818000,
                        "creationDate": 1639577548000,
                        "subscribed": 0,
                        "daysLeft": 30,
                        "showLanding": true,
                        "reseller": null,
                        "groupId": null,
                        "alertsLastReseted": ***,
                        "authRestrictions": false
                    },
                    "title": "testAnnotation",
                    "status": null,
                    "task": false
                }
            ]
        },
        {
            "idAlert": ***,
            "comments": [
                {
                    "id": ***,
                    "author": {
                        "id": 30175,
                        "user": {
                            "id": "***-***-***-***-***",
                            "email": "test@example.com",
                            "username": "tets example",
                            "telephone": "",
                            "pwd": "**************",
                            "status": 0,
                            "validation_token": "**************",
                            "defaultDomain": null,
                            "updateDate": 1681299881000,
                            "creationDate": 1659456133000,
                            "otpSecret": "**************",
                            "loginAttempts": 0,
                            "recoveryAttempts": 0
                        },
                        "domain": {
                            "id": "***-***-***-***-***",
                            "name": "partner_domain",
                            "status": 0,
                            "type": 11,
                            "updateDate": 1679684818000,
                            "creationDate": 1639577548000,
                            "subscribed": 0,
                            "daysLeft": 30,
                            "showLanding": true,
                            "reseller": null,
                            "groupId": null,
                            "alertsLastReseted": 1679684818000,
                            "authRestrictions": false
                        },
                        "lastTimeLogged": 1673260105000,
                        "status": 0,
                        "creationDate": 1640279609000,
                        "updateDate": 1673260105000,
                        "pwd": "**************",
                        "validationToken": "**************",
                        "roleCustom": null,
                        "rolesCustom": null,
                        "externalId": null,
                        "owner": true,
                        "alertsLastVisited": ***
                    },
                    "msg": "From alerts API, test comments d3lab",
                    "ack": "{\"ackUserList\":[\"***-***-***-***-***\"]}",
                    "creationDate": 1681936005000,
                    "updateDate": 1681936005000,
                    "elementType": "alert",
                    "elementId": "***",
                    "domain": {
                        "id": "***-***-***-***-***",
                        "name": "partner_domain",
                        "status": 0,
                        "type": 11,
                        "updateDate": 1679684818000,
                        "creationDate": 1639577548000,
                        "subscribed": 0,
                        "daysLeft": 30,
                        "showLanding": true,
                        "reseller": null,
                        "groupId": null,
                        "alertsLastReseted": 1679684818000,
                        "authRestrictions": false
                    },
                    "title": "testAnnotation",
                    "status": null,
                    "task": 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

IDALERT

COMMENTS

163784909

[{'id': ***, 'author': {'id': ***, 'user': {'id': '8de3d21e-***-***-***-***-***', 'email': 'test@example.com', 'username': 'test example', 'telephone': '', 'pwd': '**************', 'status': 0, 'validation_token': '**************', 'defaultDomain': None, 'updateDate': 1681299881000, 'creationDate': 1659456133000, 'otpSecret': '**************', 'loginAttempts': 0, 'recoveryAttempts': 0}, 'domain': {'id': '***-***-***-***-***', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': ***, 'authRestrictions': False}, 'lastTimeLogged': 1673260105000, 'status': 0, 'creationDate': 1640279609000, 'updateDate': 1673260105000, 'pwd': '**************', 'validationToken': '**************', 'roleCustom': None, 'rolesCustom': None, 'externalId': None, 'owner': True, 'alertsLastVisited': 1662488300000}, 'msg': 'From alerts API, test comments d3lab', 'ack': '{"ackUserList":["***-***-***-***-***"]}', 'creationDate': 1681936387000, 'updateDate': 1681936387000, 'elementType': 'alert', 'elementId': '***', 'domain': {'id': '***-***-***-***-***', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': ***, 'authRestrictions': False}, 'title': 'testAnnotation', 'status': None, 'task': 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.	Add Comment To 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 Devo Alerts 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: Comment IDs parameter is required for Reply comment type. You can get Comment ID with the Get Alert Details command.

Error Sample Data

Add Comment To Alerts failed.

Status Code: 400.

Message: Comment IDs parameter is required for Reply comment type. You can get Comment ID with the Get Alert Details command.

Fetch Event

Returns Alerts from the Devo platform based on specified criteria(s).

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Required	The start time of the time range to fetch events triggered after the specified timestamp, in UTC format.	2023-03-05 00:00
End Time	Optional	The end time of the time range to fetch events triggered before the specified timestamp, in UTC format. If this parameter is not defined, the default value is the current time.	2023-03-10 00:00
Number of Event(s) Fetched	Optional	The maximum number of events to return, with the most recently updated event being returned first. If this parameter is not defined, all alerts occurring between the Start Time and End Time will be returned.	5
Show All	Optional	The option to retrieve all triggered alerts, including the ones with false positive and closed status, when set to True. By default, the value is set to False.	False
Tolerance Scope	Optional	The tolerance scope in minutes of the query to fetch event between start and end time to avoid the loss of events. Events will be fetched between {Start Time - Tolerance Scope}. The default value is 0.	5

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "id": ***,
        "domain": "partner_domain",
        "priority": 5,
        "context": "my.alert.partner_domain.detection",
        "category": "my.context",
        "srcPort": null,
        "srcIp": null,
        "srcHost": null,
        "dstIp": null,
        "dstPort": null,
        "dstHost": null,
        "protocol": null,
        "username": "test@example.com",
        "application": null,
        "engine": "***",
        "extraData": "{\"customerIDString\":\"***\",\"count\":\"15\",\"eventdate\":\"2023-03-06+19%3A00%3A00.0\"}",
        "alertDate": null,
        "status": 100,
        "ack_status_date": null,
        "createDate": 1678129535000,
        "updateDate": null,
        "scaled": false,
        "digest": "***",
        "uniquedigest": "***",
        "postAlertAction": null,
        "contextLabel": null,
        "contextSubscription": null,
        "shouldSend": false,
        "alertOwner": null,
        "fullExtraData": null,
        "alertType": null,
        "alertMitreTactics": null,
        "alertMitreTechniques": null,
        "alertPriority": null,
        "alertDefinition": {
            "id": "***",
            "creationDate": 1676352118000,
            "name": "detection",
            "message": "alert for d_s",
            "description": "This is an alert in crowdstrike d_s",
            "categoryId": "**8",
            "subcategory": "lib.my.partner_domain.edr",
            "subcategoryId": "***",
            "isActive": true,
            "isFavorite": false,
            "isAlertChain": false,
            "alertCorrelationContext": {
                "id": "64793",
                "nameId": "my.alert.partner_domain.detection",
                "ownerEmail": "test@example.com",
                "querySourceCode": "from edr.crowdstrike.falconstreaming.detection_summary\nselect str(LocalIP) as srcIp",
                "priority": 5,
                "correlationTrigger": {
                    "kind": "several",
                    "period": 300000,
                    "threshold": 10,
                    "keys": [
                        "customerIDString"
                    ]
                }
            },
            "actionPolicyId": []
        },
        "allExtraDataFields": {
            "customerIDString": "***",
            "count": "15",
            "eventdate": "2023-03-06+19%3A00%3A00.0"
        },
        "tags": null,
        "entities": null,
        "commentsList": null,
        "integrations": null,
        "contexto": 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

CODE

{
    "AlertIDs": "\"[ ***]\"",
    "AlertPriorities": "\"[ 5.0 ]\"",
    "AlertStatuses": "\"[ 100 ]\""
}

Return Data

Indicates one of the possible command execution states: Successful, Successful but no events, 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.

As a system integration, the Devo Alerts 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 Key is $.id.

The pre-configured field mappings are detailed below:

Field Name	Source Field
Unique Event Key	.id
Start Time	.createdate
Event Type	.context
Status	.status
Priority	.priority
Tactics	.alertMitreTactics
Techniques	.alertMitreTechniques
Event category	.category
Source hostname	.srcHost
Source IP address	.srcIp
Source port	.srcPort
Destination hostname	.dstHost
Destination IP address	.dstIp
Destination port	.dstPort
Protocol info	.protocol
Username	.username
Extra Data	.extraData
Alert Definition ID	.alertDefinition.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.	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 Devo Alerts 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 (Tolerance Scope) is invalid.

Error Sample Data

Fetch Event failed.

Status Code: 400.

Message: The value for parameter (Tolerance Scope) is invalid.

Get Alert Details

Retrieves detailed information about the specified alert(s).

Reader Note

The parameter Alert IDs is required to run this command.

You should already have your desired Alert IDs on hand to run this command. If you don’t, you can use the Fetch Event command with defined filters to retrieve the desired Alert IDs. The Alert IDs can be found in the raw data at the path $[*].id.

Input

Input Parameter	Required /Optional	Description	Example
Alert IDs	Required	The IDs of the alerts to retrieve details.	["163784909"]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

[
    {
        "id": 163784909,
        "domain": "partner_domain",
        "priority": 5,
        "context": "my.alert.partner_domain.detection",
        "category": "my.context",
        "srcPort": null,
        "srcIp": null,
        "srcHost": null,
        "dstIp": null,
        "dstPort": null,
        "dstHost": null,
        "protocol": null,
        "username": "devo@safebreach.com",
        "application": null,
        "engine": "pilot-8-pro-cloud-custom-aws-us-east-1",
        "extraData": "{\"customerIDString\":\"9140393f79cd4b3ca3298ec0d718d788\",\"count\":\"15\",\"eventdate\":\"2023-03-06+19%3A00%3A00.0\"}",
        "alertDate": null,
        "status": 1,
        "ack_status_date": null,
        "createDate": 1678129535000,
        "updateDate": 1681935213000,
        "scaled": false,
        "digest": "aaa86bab7b41e9cf6e56141314c7dcd7ccc2259f",
        "uniquedigest": "fc303df78461f17b9da187ba23d7e83c50a4afc3",
        "postAlertAction": null,
        "contextLabel": null,
        "contextSubscription": null,
        "shouldSend": false,
        "alertOwner": null,
        "fullExtraData": null,
        "alertType": null,
        "alertMitreTactics": null,
        "alertMitreTechniques": null,
        "alertPriority": null,
        "alertDefinition": null,
        "allExtraDataFields": null,
        "tags": null,
        "entities": null,
        "commentsList": [
            {
                "id": 756100,
                "author": {
                    "id": 30175,
                    "user": {
                        "id": "8de3d21e-0b5e-4ae1-97e0-92bf90863fef",
                        "email": "nipun.gupta@devo.com",
                        "username": "Nipun Gupta",
                        "telephone": "",
                        "pwd": "5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=",
                        "status": 0,
                        "validation_token": null,
                        "defaultDomain": null,
                        "updateDate": 1681299881000,
                        "creationDate": 1659456133000,
                        "otpSecret": null,
                        "loginAttempts": 0,
                        "recoveryAttempts": 0
                    },
                    "domain": {
                        "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                        "name": "partner_domain",
                        "status": 0,
                        "type": 11,
                        "updateDate": 1679684818000,
                        "creationDate": 1639577548000,
                        "subscribed": 0,
                        "daysLeft": 30,
                        "showLanding": true,
                        "reseller": null,
                        "groupId": null,
                        "alertsLastReseted": 1679684818000,
                        "authRestrictions": false
                    },
                    "lastTimeLogged": 1673260105000,
                    "status": 0,
                    "creationDate": 1640279609000,
                    "updateDate": 1673260105000,
                    "pwd": null,
                    "validationToken": null,
                    "roleCustom": null,
                    "rolesCustom": null,
                    "externalId": null,
                    "owner": true,
                    "alertsLastVisited": 1662488300000
                },
                "msg": "From alerts API, test comments d3lab",
                "ack": "{\"ackUserList\":[\"8de3d21e-0b5e-4ae1-97e0-92bf90863fef\"]}",
                "creationDate": 1681938354000,
                "updateDate": 1681938354000,
                "elementType": "alert",
                "elementId": "163784909",
                "domain": {
                    "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                    "name": "partner_domain",
                    "status": 0,
                    "type": 11,
                    "updateDate": 1679684818000,
                    "creationDate": 1639577548000,
                    "subscribed": 0,
                    "daysLeft": 30,
                    "showLanding": true,
                    "reseller": null,
                    "groupId": null,
                    "alertsLastReseted": 1679684818000,
                    "authRestrictions": false
                },
                "title": "test Annotation",
                "status": null,
                "task": false
            },
            {
                "id": 755771,
                "author": {
                    "id": 30175,
                    "user": {
                        "id": "8de3d21e-0b5e-4ae1-97e0-92bf90863fef",
                        "email": "nipun.gupta@devo.com",
                        "username": "Nipun Gupta",
                        "telephone": "",
                        "pwd": "5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=",
                        "status": 0,
                        "validation_token": null,
                        "defaultDomain": null,
                        "updateDate": 1681299881000,
                        "creationDate": 1659456133000,
                        "otpSecret": null,
                        "loginAttempts": 0,
                        "recoveryAttempts": 0
                    },
                    "domain": {
                        "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                        "name": "partner_domain",
                        "status": 0,
                        "type": 11,
                        "updateDate": 1679684818000,
                        "creationDate": 1639577548000,
                        "subscribed": 0,
                        "daysLeft": 30,
                        "showLanding": true,
                        "reseller": null,
                        "groupId": null,
                        "alertsLastReseted": 1679684818000,
                        "authRestrictions": false
                    },
                    "lastTimeLogged": 1673260105000,
                    "status": 0,
                    "creationDate": 1640279609000,
                    "updateDate": 1673260105000,
                    "pwd": null,
                    "validationToken": null,
                    "roleCustom": null,
                    "rolesCustom": null,
                    "externalId": null,
                    "owner": true,
                    "alertsLastVisited": 1662488300000
                },
                "msg": "From alerts API, test comments d3lab",
                "ack": "{\"ackUserList\":[\"8de3d21e-0b5e-4ae1-97e0-92bf90863fef\"]}",
                "creationDate": 1681936387000,
                "updateDate": 1681936387000,
                "elementType": "alert",
                "elementId": "163784909",
                "domain": {
                    "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                    "name": "partner_domain",
                    "status": 0,
                    "type": 11,
                    "updateDate": 1679684818000,
                    "creationDate": 1639577548000,
                    "subscribed": 0,
                    "daysLeft": 30,
                    "showLanding": true,
                    "reseller": null,
                    "groupId": null,
                    "alertsLastReseted": 1679684818000,
                    "authRestrictions": false
                },
                "title": "testAnnotation",
                "status": null,
                "task": false
            },
            {
                "id": 755769,
                "author": {
                    "id": 30175,
                    "user": {
                        "id": "8de3d21e-0b5e-4ae1-97e0-92bf90863fef",
                        "email": "nipun.gupta@devo.com",
                        "username": "Nipun Gupta",
                        "telephone": "",
                        "pwd": "5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=",
                        "status": 0,
                        "validation_token": null,
                        "defaultDomain": null,
                        "updateDate": 1681299881000,
                        "creationDate": 1659456133000,
                        "otpSecret": null,
                        "loginAttempts": 0,
                        "recoveryAttempts": 0
                    },
                    "domain": {
                        "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                        "name": "partner_domain",
                        "status": 0,
                        "type": 11,
                        "updateDate": 1679684818000,
                        "creationDate": 1639577548000,
                        "subscribed": 0,
                        "daysLeft": 30,
                        "showLanding": true,
                        "reseller": null,
                        "groupId": null,
                        "alertsLastReseted": 1679684818000,
                        "authRestrictions": false
                    },
                    "lastTimeLogged": 1673260105000,
                    "status": 0,
                    "creationDate": 1640279609000,
                    "updateDate": 1673260105000,
                    "pwd": null,
                    "validationToken": null,
                    "roleCustom": null,
                    "rolesCustom": null,
                    "externalId": null,
                    "owner": true,
                    "alertsLastVisited": 1662488300000
                },
                "msg": "From alerts API, test comments d3lab",
                "ack": "{\"ackUserList\":[\"8de3d21e-0b5e-4ae1-97e0-92bf90863fef\"]}",
                "creationDate": 1681936383000,
                "updateDate": 1681936383000,
                "elementType": "alert",
                "elementId": "163784909",
                "domain": {
                    "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                    "name": "partner_domain",
                    "status": 0,
                    "type": 11,
                    "updateDate": 1679684818000,
                    "creationDate": 1639577548000,
                    "subscribed": 0,
                    "daysLeft": 30,
                    "showLanding": true,
                    "reseller": null,
                    "groupId": null,
                    "alertsLastReseted": 1679684818000,
                    "authRestrictions": false
                },
                "title": "testAnnotation",
                "status": null,
                "task": false
            },
            {
                "id": 755767,
                "author": {
                    "id": 30175,
                    "user": {
                        "id": "8de3d21e-0b5e-4ae1-97e0-92bf90863fef",
                        "email": "nipun.gupta@devo.com",
                        "username": "Nipun Gupta",
                        "telephone": "",
                        "pwd": "5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=",
                        "status": 0,
                        "validation_token": null,
                        "defaultDomain": null,
                        "updateDate": 1681299881000,
                        "creationDate": 1659456133000,
                        "otpSecret": null,
                        "loginAttempts": 0,
                        "recoveryAttempts": 0
                    },
                    "domain": {
                        "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                        "name": "partner_domain",
                        "status": 0,
                        "type": 11,
                        "updateDate": 1679684818000,
                        "creationDate": 1639577548000,
                        "subscribed": 0,
                        "daysLeft": 30,
                        "showLanding": true,
                        "reseller": null,
                        "groupId": null,
                        "alertsLastReseted": 1679684818000,
                        "authRestrictions": false
                    },
                    "lastTimeLogged": 1673260105000,
                    "status": 0,
                    "creationDate": 1640279609000,
                    "updateDate": 1673260105000,
                    "pwd": null,
                    "validationToken": null,
                    "roleCustom": null,
                    "rolesCustom": null,
                    "externalId": null,
                    "owner": true,
                    "alertsLastVisited": 1662488300000
                },
                "msg": "From alerts API, test comments d3lab",
                "ack": "{\"ackUserList\":[\"8de3d21e-0b5e-4ae1-97e0-92bf90863fef\"]}",
                "creationDate": 1681936372000,
                "updateDate": 1681936372000,
                "elementType": "alert",
                "elementId": "163784909",
                "domain": {
                    "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                    "name": "partner_domain",
                    "status": 0,
                    "type": 11,
                    "updateDate": 1679684818000,
                    "creationDate": 1639577548000,
                    "subscribed": 0,
                    "daysLeft": 30,
                    "showLanding": true,
                    "reseller": null,
                    "groupId": null,
                    "alertsLastReseted": 1679684818000,
                    "authRestrictions": false
                },
                "title": "testAnnotation",
                "status": null,
                "task": false
            },
            {
                "id": 755737,
                "author": {
                    "id": 30175,
                    "user": {
                        "id": "8de3d21e-0b5e-4ae1-97e0-92bf90863fef",
                        "email": "nipun.gupta@devo.com",
                        "username": "Nipun Gupta",
                        "telephone": "",
                        "pwd": "5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=",
                        "status": 0,
                        "validation_token": null,
                        "defaultDomain": null,
                        "updateDate": 1681299881000,
                        "creationDate": 1659456133000,
                        "otpSecret": null,
                        "loginAttempts": 0,
                        "recoveryAttempts": 0
                    },
                    "domain": {
                        "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                        "name": "partner_domain",
                        "status": 0,
                        "type": 11,
                        "updateDate": 1679684818000,
                        "creationDate": 1639577548000,
                        "subscribed": 0,
                        "daysLeft": 30,
                        "showLanding": true,
                        "reseller": null,
                        "groupId": null,
                        "alertsLastReseted": 1679684818000,
                        "authRestrictions": false
                    },
                    "lastTimeLogged": 1673260105000,
                    "status": 0,
                    "creationDate": 1640279609000,
                    "updateDate": 1673260105000,
                    "pwd": null,
                    "validationToken": null,
                    "roleCustom": null,
                    "rolesCustom": null,
                    "externalId": null,
                    "owner": true,
                    "alertsLastVisited": 1662488300000
                },
                "msg": "From alerts API, test comments d3lab",
                "ack": "{\"ackUserList\":[\"8de3d21e-0b5e-4ae1-97e0-92bf90863fef\"]}",
                "creationDate": 1681936005000,
                "updateDate": 1681936005000,
                "elementType": "alert",
                "elementId": "163784909",
                "domain": {
                    "id": "111db226-6ed8-4fa6-ad46-359167ff5f3c",
                    "name": "partner_domain",
                    "status": 0,
                    "type": 11,
                    "updateDate": 1679684818000,
                    "creationDate": 1639577548000,
                    "subscribed": 0,
                    "daysLeft": 30,
                    "showLanding": true,
                    "reseller": null,
                    "groupId": null,
                    "alertsLastReseted": 1679684818000,
                    "authRestrictions": false
                },
                "title": "testAnnotation",
                "status": null,
                "task": false
            }
        ],
        "integrations": null,
        "contexto": 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

CODE

{
    "AlertIDs": "\"[ 163784909 ]\"",
    "AlertPriorities": "\"[ 5.0 ]\"",
    "AlertStatuses": "\"[ 1 ]\""
}

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

ID	DOMAIN	PRIORITY	CONTEXT	CATEGORY	SRCPORT	SRCIP	SRCHOST	DSTIP	DSTPORT	DSTHOST	PROTOCOL	USERNAME	APPLICATION	ENGINE	EXTRADATA	ALERTDATE	STATUS	ACK_STATUS_DATE	CREATEDATE	UPDATEDATE	SCALED	DIGEST	UNIQUEDIGEST	POSTALERTACTION	CONTEXTLABEL	CONTEXTSUBSCRIPTION	SHOULDSEND	ALERTOWNER	FULLEXTRADATA	ALERTTYPE	ALERTMITRETACTICS	ALERTMITRETECHNIQUES	ALERTPRIORITY	ALERTDEFINITION	ALLEXTRADATAFIELDS	TAGS	ENTITIES	COMMENTSLIST	INTEGRATIONS	CONTEXTO
163784909	partner_domain	5.0	my.alert.partner_domain.detection	my.context	None	None	None	None	None	None	None	devo@safebreach.com	None	pilot-8-pro-cloud-custom-aws-us-east-1	{"customerIDString":"9140393f79cd4b3ca3298ec0d718d788","count":"15","eventdate":"2023-03-06+19%3A00%3A00.0"}	None	1	None	1678129535000	1681935213000	False	aaa86bab7b41e9cf6e56141314c7dcd7ccc2259f	fc303df78461f17b9da187ba23d7e83c50a4afc3	None	None	None	False	None	None	None	None	None	None	None	None	None	None	[{'id': 756100, 'author': {'id': 30175, 'user': {'id': '8de3d21e-0b5e-4ae1-97e0-92bf90863fef', 'email': 'nipun.gupta@devo.com', 'username': 'Nipun Gupta', 'telephone': '', 'pwd': '5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=', 'status': 0, 'validation_token': None, 'defaultDomain': None, 'updateDate': 1681299881000, 'creationDate': 1659456133000, 'otpSecret': None, 'loginAttempts': 0, 'recoveryAttempts': 0}, 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'lastTimeLogged': 1673260105000, 'status': 0, 'creationDate': 1640279609000, 'updateDate': 1673260105000, 'pwd': None, 'validationToken': None, 'roleCustom': None, 'rolesCustom': None, 'externalId': None, 'owner': True, 'alertsLastVisited': 1662488300000}, 'msg': 'From alerts API, test comments d3lab', 'ack': '{"ackUserList":["8de3d21e-0b5e-4ae1-97e0-92bf90863fef"]}', 'creationDate': 1681938354000, 'updateDate': 1681938354000, 'elementType': 'alert', 'elementId': '163784909', 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'title': 'test Annotation', 'status': None, 'task': False}, {'id': 755771, 'author': {'id': 30175, 'user': {'id': '8de3d21e-0b5e-4ae1-97e0-92bf90863fef', 'email': 'nipun.gupta@devo.com', 'username': 'Nipun Gupta', 'telephone': '', 'pwd': '5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=', 'status': 0, 'validation_token': None, 'defaultDomain': None, 'updateDate': 1681299881000, 'creationDate': 1659456133000, 'otpSecret': None, 'loginAttempts': 0, 'recoveryAttempts': 0}, 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'lastTimeLogged': 1673260105000, 'status': 0, 'creationDate': 1640279609000, 'updateDate': 1673260105000, 'pwd': None, 'validationToken': None, 'roleCustom': None, 'rolesCustom': None, 'externalId': None, 'owner': True, 'alertsLastVisited': 1662488300000}, 'msg': 'From alerts API, test comments d3lab', 'ack': '{"ackUserList":["8de3d21e-0b5e-4ae1-97e0-92bf90863fef"]}', 'creationDate': 1681936387000, 'updateDate': 1681936387000, 'elementType': 'alert', 'elementId': '163784909', 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'title': 'testAnnotation', 'status': None, 'task': False}, {'id': 755769, 'author': {'id': 30175, 'user': {'id': '8de3d21e-0b5e-4ae1-97e0-92bf90863fef', 'email': 'nipun.gupta@devo.com', 'username': 'Nipun Gupta', 'telephone': '', 'pwd': '5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=', 'status': 0, 'validation_token': None, 'defaultDomain': None, 'updateDate': 1681299881000, 'creationDate': 1659456133000, 'otpSecret': None, 'loginAttempts': 0, 'recoveryAttempts': 0}, 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'lastTimeLogged': 1673260105000, 'status': 0, 'creationDate': 1640279609000, 'updateDate': 1673260105000, 'pwd': None, 'validationToken': None, 'roleCustom': None, 'rolesCustom': None, 'externalId': None, 'owner': True, 'alertsLastVisited': 1662488300000}, 'msg': 'From alerts API, test comments d3lab', 'ack': '{"ackUserList":["8de3d21e-0b5e-4ae1-97e0-92bf90863fef"]}', 'creationDate': 1681936383000, 'updateDate': 1681936383000, 'elementType': 'alert', 'elementId': '163784909', 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'title': 'testAnnotation', 'status': None, 'task': False}, {'id': 755767, 'author': {'id': 30175, 'user': {'id': '8de3d21e-0b5e-4ae1-97e0-92bf90863fef', 'email': 'nipun.gupta@devo.com', 'username': 'Nipun Gupta', 'telephone': '', 'pwd': '5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=', 'status': 0, 'validation_token': None, 'defaultDomain': None, 'updateDate': 1681299881000, 'creationDate': 1659456133000, 'otpSecret': None, 'loginAttempts': 0, 'recoveryAttempts': 0}, 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'lastTimeLogged': 1673260105000, 'status': 0, 'creationDate': 1640279609000, 'updateDate': 1673260105000, 'pwd': None, 'validationToken': None, 'roleCustom': None, 'rolesCustom': None, 'externalId': None, 'owner': True, 'alertsLastVisited': 1662488300000}, 'msg': 'From alerts API, test comments d3lab', 'ack': '{"ackUserList":["8de3d21e-0b5e-4ae1-97e0-92bf90863fef"]}', 'creationDate': 1681936372000, 'updateDate': 1681936372000, 'elementType': 'alert', 'elementId': '163784909', 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'title': 'testAnnotation', 'status': None, 'task': False}, {'id': 755737, 'author': {'id': 30175, 'user': {'id': '8de3d21e-0b5e-4ae1-97e0-92bf90863fef', 'email': 'nipun.gupta@devo.com', 'username': 'Nipun Gupta', 'telephone': '', 'pwd': '5/Xg5fINEbx02FhYlDr8CVE5H4qfd+lb+NuDU/0e7x0=$pKa4pRdna1QGWTfZEOekv3rdeeo6AvDXPUw99s+2Qmc=', 'status': 0, 'validation_token': None, 'defaultDomain': None, 'updateDate': 1681299881000, 'creationDate': 1659456133000, 'otpSecret': None, 'loginAttempts': 0, 'recoveryAttempts': 0}, 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'lastTimeLogged': 1673260105000, 'status': 0, 'creationDate': 1640279609000, 'updateDate': 1673260105000, 'pwd': None, 'validationToken': None, 'roleCustom': None, 'rolesCustom': None, 'externalId': None, 'owner': True, 'alertsLastVisited': 1662488300000}, 'msg': 'From alerts API, test comments d3lab', 'ack': '{"ackUserList":["8de3d21e-0b5e-4ae1-97e0-92bf90863fef"]}', 'creationDate': 1681936005000, 'updateDate': 1681936005000, 'elementType': 'alert', 'elementId': '163784909', 'domain': {'id': '111db226-6ed8-4fa6-ad46-359167ff5f3c', 'name': 'partner_domain', 'status': 0, 'type': 11, 'updateDate': 1679684818000, 'creationDate': 1639577548000, 'subscribed': 0, 'daysLeft': 30, 'showLanding': True, 'reseller': None, 'groupId': None, 'alertsLastReseted': 1679684818000, 'authRestrictions': False}, 'title': 'testAnnotation', 'status': None, 'task': False}]	None	None

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 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 Devo Alerts 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: Invalid alert ID.

Error Sample Data

Get Alert Details failed.

Status Code: 400.

Message: Invalid alert ID.

Update Alert Status

Updates alert statuses in bulk.

Reader Note

The parameter Alert IDs is required to run this command.

You should already have your desired Alert IDs on hand to run this command. If you don’t, you can use the Fetch Event command with defined filters to retrieve the desired Alert IDs. The Alert IDs can be found in the raw data at the path $[*].id.

Input

Input Parameter	Required /Optional	Description	Example
Alert IDs	Required	The IDs of the alerts to update status. Alert IDs can be obtained using the Fetch Event command.	["163784909","163768055"]
Status	Required	The updated status of the specified alerts.	Updated

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON

{
    "ids": [
        "163784909",
        "163768055"
    ],
    "message": "Alerts are updated successful"
}

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

ids	163784909 163768055
message	Alerts are updated successful

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.	Update Alert Status 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 Devo Alerts 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 update alert with id xxx into domain partner_domain to status 0.

Error Sample Data

Update Alert Status failed.

Status Code: 400.

Message: Could not update alert with id xxx into domain partner_domain to status 0.

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 Devo Alerts 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: Name or service not known.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 400.

Message: Name or service not known.