Remove Value from a Global List
Removes all key/value pairs with input value from a Global List with specified name.
Implementation | System |
Command Category | System Utility |
Tags | GLOBAL LIST |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
List Name | Optional | The name of a Global list. |
|
Value to Remove | Optional | The value used to remove the elements with a key's value equals to. |
|
Output
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
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
{
"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 |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
List Name |
| Optional | The name of a Global list. |
Value to Remove |
| Optional | The value used to remove the elements with a key's value equals to. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"List Name": "CriticalAssets",
"Value to Remove": "Testing_Host_1"
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
contextData |
| The context data from the API request. |
Sample Response
{
"error": "",
"returnData": "Succeed",
"contextData": [
{
"ipAddress": "192.168.1.01",
},
{
"ipAddress": "192.168.1.02",
"hostName": "Testing_Host_2"
}
]
}