Skip to main content
Skip table of contents

Remove Incident Tags

LAST UPDATED: SEPT 04, 2024

Removes either the the selected tags or all tags from an incident.

Implementation

System

Command Category

System Utility

Tags

INCIDENT INCIDENT TAG

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Incident Number

Required

The incident number from which incident tags will be removed.

20230714-3

Tags

Optional

The incident tags to be removed. If this field is left empty, all tags will be removed.

CODE
[
    "test6",
    "test7"
]

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON
{
    "Status": "Successful",
    "Data": {
        "incidentNumber": "20230714-3",
        "Tags": [
            "test4",
            "test5"
        ],
        "modifiedDate": "7/14/2023 5:19:09 PM",
        "result": "Successful",
        "modifiedBy": "Jackie Gao"
    }
}

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/RemoveIncidentTags

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": {
    "Incident Number": "<Incident Number here>",
    "Tags": "<Tags here>"
  }
}

Body Parameters

Parameter Name

Type

Required/Optional

Description

Username

string

Required

The username of your D3 SOAR account.

Site

string

Required

The D3 SOAR site to run the remote command.

Incident Number

string

Required

The incident number from which incident tags will be removed.

Tags

array<string>

Optional

The incident tags to be removed. If this field is left empty, all tags will be removed.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20230714-3",
    "Tags": [
      "test6",
      "test7"
    ]
  }
}

Response

Response Fields

Field Name

Type

Description

error

string

The error message if the API request has failed.

returnData

JSON Object

The return data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": {
      "Status": "Successful",
      "Data": {
          "incidentNumber": "20230714-3",
          "Tags": [
              "test4",
              "test5"
          ],
          "modifiedDate": "7/14/2023 5:19:09 PM",
          "result": "Successful",
          "modifiedBy": "Jackie Gao"
      }
    }
}
JavaScript errors detected

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

If this problem persists, please contact our support.