Skip to main content
Skip table of contents

Sync Global List

This command synchronizes a global list from the master to a specific tenant, 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

Optional

The global list name

MacToSysNameMappingList

Region

Optional

The region of the tenant

United States

Tenant Name

Optional

Tenant Name for the global list

Tenant_Name01

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

CODE
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

Text

Optional

Option to share all tagged connection or just ones provided in connection info

Site

Text

Optional

Information about the automation rule to sync

List Name

Text

Optional

The global list name

Region

Text

Optional

The region of the tenant

Tenant Name

Text

Optional

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

text

The error message if the API request has failed.

returnData

text

The return data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": "Successful"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.