Sync Event Automation Rule

This utility command enables the synchronization of event automation rule from the master to the tenant instance.

Implementation	System
Command Category	System Utility
Tags	AUTOMATION RULE MULTITENANCY

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Sync All Shared	Optional	Option to share all tagged connection or just ones provided in connection info	`False`
Automation Info	Optional	Information about the automation rule to sync	CODE `[ { "RuleId": 123 }, { "RuleId": 321 } ]`
Tenant Region	Optional	Region of the tenant	`AMER`
Tenant Name	Optional	Name of the tenant	`TestTenant`
Sync All Tenant Sites	Optional	Option to sync to all tenant sites within the region and tenant name or select one site base on the tenant site input	`False`
Tenant Site	Optional	Tenant site to sync to	`TenantSite`

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/SyncEventAutomationRule

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>,
    "Region": <Region here>,
    "TenantName": <Tenant Name here>
    "Sync All Shared": <Sync All Shared here>,
    "Connection Info": <Connection Info here>,
    "Tenant Region": <Tenant Region here>,
    "Tenant Name": <Tenant Name here>,
    "Tenant Site": <Tenant Sitehere>,
  }
}

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
Sync All Shared	`Boolean`	Optional	Region of the tenant
Automation Info	`JSON Array`	Optional	Name of the tenant
Tenant Region	`Text`	Optional	Option to sync to all tenant sites within the region and tenant name or select one site base on the tenant site input
Tenant Name	`Text`	Optional	Tenant site to sync to
Sync All Tenant Sites	`Boolean`	Optional	Option to share all tagged connection or just ones provided in connection info
Tenant Site	`Text`	Optional	Information about the automation rule to sync

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Sync All Shared": "False",
    "Automation Info": [
      {
        "RuleId": 123
      },
      {
        "RuleId": 321
      }
    ],
    "Tenant Region": "AMER",
    "Tenant Name": "TestTenant",
    "Sync All Tenant Sites": "False",
    "Tenant Site": "TenantSite"
  }
}

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"
}