Create Site

LAST UPDATED: AUG 12, 2024

Establishes a new internal or client site.

Implementation	System
Command Category	System Utility
Tags	SITE

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Site Name	Required	The name for the new site.	demoSite
Site Description	Optional	The description for the new site.	demoDescription
Site Type	Optional	The type for the new site, with available options being: Internal Client The default type is Client.	Client
Shared Connection	Optional	Whether to designate the internal site being created as the recipient site. The default value is False.	False
Is Active	Optional	Whether the new site is active. Setting this to False will make the site offline and unusable. The default value is True.	True
Time Zone	Optional	The time zone for the new site. The default setting is Greenwich Mean Time.	(GMT-08:00) Pacific Standard Time
Language	Optional	The language for the new site. The default value is English.	Default(English)
Is Master	Optional	Whether the new site is a master site. The default value is False.	False

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

JSON

Successful

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

{
    "success": true,
    "message": "Successfully added the site: demoSite",
    "data": 100019
}

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

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": {
    "Site Name": "<SiteName here>",
    "Site Description": "<Site Description here>",
    "Site Type": "<Site Type here>",
    "Shared Connection": "<Shared Connection here>",
    "Is Active": "<Is Active here>",
    "Time Zone": "<Time Zone here>",
    "Language": "<Language here>",
    "Is Master": "<Is Master here>"
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Site Name	`string`	Required	The name for the new site.
Site Description	`string`	Optional	The description for the new site.
Site Type	`string`	Optional	The type for the new site, with available options being: Internal Client The default type is Client.
Shared Connection	`string`	Optional	Whether to designate the internal site being created as the recipient site. The default value is False.
Is Active	`string`	Optional	Whether the new site is active. Setting this to False will make the site offline and unusable. The default value is True.
Time Zone	`string`	Optional	The time zone for the new site. The default setting is Greenwich Mean Time.
Language	`string`	Optional	The language for the new site. The default value is English.
Is Master	`string`	Optional	Whether the new site is a master site. The default value is False.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Site Name": "demoSite",
    "Site Description": "demoDescription",
    "Site Type": "Client",
    "Shared Connection": "False",
    "Is Active": "True",
    "Time Zone": "(GMT-08:00) Pacific Standard Time",
    "Language": "Default(English)",
    "Is Master": "False"
  }
}

Response

Response Fields

Field Name	Type	Description
result	`string`	The message conveying the outcome of site creation.
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request
rawData	`JSON Object`	The raw data from the API request.
contextData	`JSON Object`	The context data from the API request.

Sample Response

JSON

{
    "result": "Successfully added the site:demoSite",
    "error": "",
    "returnData": "Successful",
    "rawData": {
        "result": {
            "success": true,
            "data": {
                "TenantSite": "demoSite",
                "TenantSiteId": 100019,
                "IsActive": true
            },
            "context": {
                "success": true,
                "message": "Successfully added the site:demoSite",
                "data": 100019
            }
        }
    },
    "contextData": {
        "success": true,
        "message": "Successfully added the site:demoSite",
        "data": 100019
    }
}