Update Incidents' Site in Bulk‎

POST /Command/UpdateIncidentSiteInBulk

Update multiple incidents' site by the input incident numbers and site name.

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 Numbers	`array<string>`	Required	The array of incident numbers of incidents whose site will be updated.
Site	`string`	Required	The name of the new site of the incidents.
Username	`string`	Optional	The username of user that updates the incidents' site. This username will be used only when the task is run automatically.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Numbers": [
      "20210127-198",
      "20210127-197"
    ],
    "Site": "Security Operations",
    "Username": "admin user"
  }
}

Response

200 OK

application/json

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.
contextData	`array<JSON Object>`	The context data from the API request.

CODE

{
    "error": "",
    "returnData": "Successful",
    "contextData": [
        {
            "Incident Number": "20210127-198",
            "Incident Owner": "Security Operations",
            "Result": "Successful"
        },
        {
            "Incident Number": "20210127-197",
            "Incident Owner": "Security Operations",
            "Result": "Successful"
        }
    ]
}

401 Unauthorized

application/json

Response Fields

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

Sample Data

CODE

{"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

CODE

{"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

CODE

{"Error": "Unexpected Error."}