Add to Global List‎

POST /Command/AddToList

Adds JSON objects to the specified global list. If the specified global list does not exist, the list will be created automatically.

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.
Global List Name	`string`	Optional	The name of the global list.
JSON Objects	`array<JSON Object>`	Optional	A list of JSON objects to be added to the specified global list.

Body Sample Data

application/json

CODE

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "MacToSysNameMappingList",
    "JSON Objects": [
      {
        "GroupID": "8",
        "SystemName": "EC2AMAZ-RLKDHKC",
        "MACAddress": "020806A536xx"
      },
      {
        "GroupID": "9",
        "SystemName": "EC2AMAZ-ALKFHKA",
        "MACAddress": "090706B536xx"
      }
    ]
  }
}

Response

200 OK

application/json

Response Fields

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

Sample Data

CODE

{
    "error": "",
    "returnData": "Succeed",
    "contextData": "[
    {
        "GroupID": "4",
        "SystemName": "EC2AMAZ-82CMA0T",
        "MACAddress": "02743BEF5Cxx"
    },
    {
        "GroupID": "4",
        "SystemName": "EC2AMAZ-RLKDHKQ",
        "MACAddress": "020806A536xx"
    },
    {
        "GroupID": "8",
        "SystemName": "EC2AMAZ-RLKDHKC",
        "MACAddress": "020806A536xx"
    },
    {
        "GroupID": "9",
        "SystemName": "EC2AMAZ-ALKFHKA",
        "MACAddress": "090706B536xx"
    }
  ]"
}

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."}