Add Incident Tags ‎ | docs.d3security

POST /Command/AddIncidentTags

Add Incident Tags to the incident.

Request

Authentication: API keys or JSON web tokens (JWT)

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 to add incident tags.
Mode	`string`	Optional	The mode of add incident tags.
Tags	`array<string>`	Optional	The incident tags will be added as an array. Examples: a, b, c or ["a", "b", "c"].

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20230714-3",
    "Mode": "Append",
    "Tags": [
      "test4",
      "test5"
    ]
  }
}

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the command execution failed.
returnData	`JSON Object`	The return data from the API request.

Sample Data

{
    "error": "",
    "returnData": "{
      "Status": "Successful",
      "Data": {
          "incidentNumber": "20230714-3",
          "Tags": [
              "test4",
              "test5",
              "test6",
              "test7"
          ],
          "modifiedDate": "7/14/2023 5:03:05 PM",
          "result": "Successful",
          "modifiedBy": "Jackie xxx"
      }
  }"
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}