Skip to main content
Skip table of contents

Dismiss Event After Creation

This command is intended to dismiss an event after its creation using a specific reason code. It can only be executed within an event playbook's "On Event Ingestion" trigger.

READER NOTE

This utility command is for 16.8+, if you are in a lower version, you may encounter limitations in accessing this command. Kindly reach out to D3 for assistance in obtaining access if such a situation arises.

Implementation

Python

Command Category

System Utility

Tags

N/A

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Reason Code

Optional

The reason code that explains why the event was dismissed.

Test

Output

Raw Data

The response data from the utility command.

SAMPLE DATA

JSON
{
    "result": "Successful"
}

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE
https://{base_url}/{api_namespace}/api/Command/dismissEventAfterCreation

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON
{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "Reason Code": <Reason Code here>
  }
}

Body Parameters

Parameter Name

Type

Required/Optional

Description

Username

Text

Required

The username of your D3 SOAR account.

Site

Text

Required

The D3 SOAR site to run the remote command.

Reason Code

Number

Optional

The reason code that explains why the event was dismissed.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Reason Code": "Test"
  }
}

Response

Response Fields

Field Name

Type

Description

error

Text

The error message if the API request has failed.

returnData

Text

The return data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": "Successful"
}
JavaScript errors detected

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

If this problem persists, please contact our support.