Add to Global List
LAST UPDATED: AUG 07, 2024
Appends JSON objects to the specified global list. If the specified global list does not exist, the list will be created automatically.
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 |
JSON Objects | Required | A list of JSON objects to be added to the specified global list. |
CODE
|
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/AddToList
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": {
"Global List Name": "<Global List Name here>",
"JSON Objects": "<JSON Objects 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. |
Global List Name |
| Required | The name of the global list. |
JSON Objects |
| Required | A list of JSON objects to be added to the specified global list. |
Sample Request
SAMPLE DATA
{
"Username": "demoUsername",
"Site": "demoGlobalList",
"CommandParams": {
"Global List Name": "demoGlobalList",
"JSON Objects": [
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
{
"key4": 1234,
"key5": true,
"key6": [
"value6",
"value7"
]
}
]
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
result |
| The result from the API request. |
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
{
"result": "Successfully added to list demoGlobalList",
"error": "",
"returnData": "Succeed",
"contextData": [
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
{
"key4": 1234,
"key5": true,
"key6": [
"value6",
"value7"
]
}
]
}