Sync Event Automation Rule
LAST UPDATED: AUG 09, 2024
Enables the synchronization of event automation rule between the master and the tenant instance(s).
Implementation | System |
Command Category | System Utility |
Tags | AUTOMATION RULE MULTITENANCY |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Sync All Shared | Optional | Whether to synchronize all available automation rules. | False |
Automation Info | Optional | The specific automation rule(s) to synchronize. | [ |
Tenant Region | Required | The region of the tenant. | AMER |
Tenant Name | Required | The name of the tenant. | AMER Tenant |
Sync All Tenant Sites | Optional | The option to synchronize all tenant sites within the region, or to select a specific site provided in the Tenant Site field. | False |
Tenant Site | Optional | The tenant site to synchronize with. The tenant site must not be empty when Sync All Tenant Sites is set to False. | site001 |
READER NOTE
Either Sync All Shared or Automation Info must receive input. If both are provided, the D3 system will disregard the Automation Info input.
Either Sync All Tenant Sites or Tenant Site must receive input. If both are provided, the D3 system will disregard the Tenant Site input.
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/SyncEventAutomationRule
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>,
"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 |
| Required | The option to share all tagged connection or only the ones provided in Automation Info. |
Site |
| Required | Information about the automation rule to sync |
Sync All Shared |
| Optional | Whether to synchronize all available automation rules. |
Automation Info |
| Optional | The specific automation rule(s) to synchronize. |
Tenant Region |
| Required | The region of the tenant. |
Tenant Name |
| Required | The name of the tenant. |
Sync All Tenant Sites |
| Optional | The option to synchronize all tenant sites within the region, or to select a specific site provided in the Tenant Site field. |
Tenant Site |
| Optional | The tenant site to synchronize with. The tenant site must not be empty when Sync All Tenant Sites is set to False. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Sync All Shared": "False",
"Automation Info": [
{
"RuleId": 123
},
{
"RuleId": 321
}
],
"Tenant Region": "AMER",
"Tenant Name": "AMER Tenant",
"Sync All Tenant Sites": "False",
"Tenant Site": "site001"
}
}
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"
}