Overwrite Global List

LAST UPDATED: AUG 08, 2024

Replaces the existing content of the specified global list with the provided JSON object array.

Implementation	System
Command Category	System Utility
Tags	GLOBAL LIST

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Global List Name	Required	The name of the global list.	demoGlobalList
Global List Content	Required	The content used to overwrite the global list.	CODE `[ { "demoKeyA": "demoValueA" }, { "demoKeyB": "demoValueB" } ]`

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

Succeed

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

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": {
    "Global List Name": "<Global List Name here>",
    "Global List Content": "<Global List Content 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.
Global List Name	`string`	Required	The name of the global list.
Global List Content	`array<JSON Object>`	Required	The content used to overwrite the global list.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "demoGlobalList",
    "Global List Content": [
      {
        "demoKeyA": "demoValueA"
      },
      {
        "demoKeyB": "demoValueB"
      }
    ]
  }
}

Response

Response Fields

Field Name	Type	Description
result	`string`	The HTML table representation of the new data that has replaced the previous content in the global list.
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.

Sample Response

JSON

{
    "result": "<table class='cc-table'><tr><th>demoKeyA</th><th>demoKeyB</th></tr><tr><td>demoValueA</td><td>&nbsp;</td></tr><tr><td>&nbsp;</td><td>demoValueB</td></tr></table>",
    "error": "",
    "returnData": "Succeed"
}