Update Global List‎

POST /Command/UpdateGlobalList

Update object in the specified global list matching by key and value pair.

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.
Key	`string`	Optional	The key to match in existing global list content.
Value	`string`	Optional	The value to match in existing global list content.
Object	`JSON Object`	Optional	The object used to replace the matched objects in the global list content.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "MacToSysNameMappingList",
    "Key": "SystemName",
    "Value": "D3CYBER-PC1",
    "Object": {
      "GroupID": 8,
      "SystemName": "D3CYBER-PC3",
      "MACAddress": "000C29D332XX"
    }
  }
}

Response

200 OK

application/json

Response Fields

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	`JSON Object`	The context data from the API request.

Sample Data

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": {
        "OldList": [
            {
                "GroupID": 2,
                "SystemName": "D3Lab-AD",
                "MACAddress": "020806A536xx"
            },
            {
                "GroupID": 2,
                "SystemName": "D3LAB02",
                "MACAddress": "090706B536xx"
            },
            {
                "GroupID": 7,
                "SystemName": "D3CYBER-PC1",
                "MACAddress": "000C29D576xx"
            }
        ],
        "NewList": [
            {
                "GroupID": 2,
                "SystemName": "D3Lab-AD",
                "MACAddress": "020806A536xx"
            },
            {
                "GroupID": 2,
                "SystemName": "D3LAB02",
                "MACAddress": "090706B536xx"
            },
            {
                "GroupID": 8,
                "SystemName": "D3CYBER-PC3",
                "MACAddress": "000C29D332xx"
            }
        ]
    }
}

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