Remove Value from a Global List

LAST UPDATED: AUG 08, 2024

Removes all key-value pairs (of any object depth) from a global list based on a specified value.

Implementation	System
Command Category	System Utility
Tags	GLOBAL LIST

Inputs

Parameter Name	Required/Optional	Description	Sample Data
List Name	Required	The name of a global list.	demoGlobalList
Value to Remove	Required	The string used to select key-value pairs for deletion from the specified global list. All occurrences of this value, regardless of nesting level, will be removed.	commonValue

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

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

[
  {
    "ipAddress": "192.168.1.01"
  },
  {
    "ipAddress": "192.168.1.02"
  }
]

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

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": {
    "List Name": "<List Name here>",
    "Value to Remove": "<Value to Remove 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.
List Name	`string`	Required	The name of a global list.
Value to Remove	`string`	Required	The string used to select key-value pairs for deletion from the specified global list. All occurrences of this value, regardless of nesting level, will be removed.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "List Name": "demoGLobalList",
    "Value to Remove": "commonValue"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "result": "<table class='cc-table'><tr><th>ipAddress</th></tr><tr><td>192.168.1.01</td></tr><tr><td>192.168.1.02</td></tr></table>",
    "error": "",
    "returnData": "Succeed",
    "contextData": [
        {
            "ipAddress": "192.168.1.01"
        },
        {
            "ipAddress": "192.168.1.02"
        }
    ]
}