Update Site
Update Site
This command is specifically designed to modify essential attributes of a site, including the site name, description, site type, site status, time zone, language, and other pertinent fields.
Reader Note
Please note that this command is not publicly available. To request access, please contact D3 support.
Implementation | System |
Command Category | System Utility |
Tags | SITE |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
Target Site | Required | The target site to be updated | target site |
New Site Name | Optional | Specify the new site name for the update. | sample site |
Site Description | Optional | Specify the new site description for the update. | This is an import client site |
Site Type | Optional | Specify the new site type for the update. | Client |
Is Active | Optional | Specify the site status for the update. | True |
Time Zone | Optional | Specify the Time Zone for the update. | (GMT-08:00) Pacific Standard Time |
Language | Optional | Specify the language for the update | Default(English) |
Output
Return Data
The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.
SAMPLE DATA
{
"Status": "Successful",
"Data": {
"site": "100012",
"name": "Security Center",
"description": "This is an important site",
"type": "2",
"isActive": "true",
"timezoneId": "1",
"languageId": "20"
}
}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/UpdateSiteHeaders
Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.
Request Body
{
"Username": "<Username here>",
"Site": "<Site here>",
"CommandParams": {
"User ID": "<User ID here>",
"User Information": "<User Information 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. |
Target Site |
| Required | The target site to be updated |
New Site Name |
| Optional | Specify the new site name for the update. |
Site Description |
| Optional | Specify the new site description for the update. |
Site Type |
| Optional | Specify the new site type for the update. |
Is Active |
| Optional | Specify the site status for the update. |
Time Zone |
| Optional | Specify the Time Zone for the update. |
Language |
| Optional | Specify the language for the update |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Target Site": "target site",
"New Site Name": "sample site",
"Site Description": "new site description",
"Site Type": "Client",
"Is Active": "True",
"Time Zone": "(GMT-08:00) Pacific Standard Time",
"Language": "Default(English)"
}
}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": {
"Status": "Successful",
"Data": {
"site": "100020",
"name": "testGroup1",
"description": "new site description",
"type": "2",
"isActive": "true",
"timezoneId": "5",
"languageId": "-1"
}
}
}