Sync Global List
LAST UPDATED: AUG 09, 2024
Synchronizes the global list from the master site to a specified tenant site(s), ensuring data integrity and consistency across geographic regions and tenants.
Implementation | System |
Command Category | System Utility |
Tags | GLOBAL LIST MULTITENANCY |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
List Name | Required | The name of the global list. | demo Global List |
Region | Required | The region of the tenant. | United States |
Tenant Name | Required | The tenant name for the global list. | Tenant_Name01 |
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/SyncGlobalList
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": {
"allTenant": <allTenant here>,
"List Name": <List Name here>,
"Region": <Regionhere>,
"Tenant Name": <Tenant Name 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 |
| Required | The name of the global list. |
Region |
| Required | The region of the tenant. |
Tenant Name |
| Required | The tenant name for the global list. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"List Name": "MacToSysNameMappingList",
"Region": "United States",
"Tenant Name": "Tenant_Name01"
}
}
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. |
Sample Response
{
"error": "",
"returnData": "Successful"
}