Sync Global List | docs.d3security

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

JSON

{
  "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	`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 the global list.
Region	`string`	Required	The region of the tenant.
Tenant Name	`string`	Required	The tenant name for the global list.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "List Name": "MacToSysNameMappingList",
    "Region": "United States",
    "Tenant Name": "Tenant_Name01"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful"
}