Create Site

Add Incident Tags to the current incident.

Implementation	System
Command Category	System Utility
Tags	SITE

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Site Name	Required	Specify the site name for the new site.	`sample new site`
Site Description	Optional	Specify the site description for the new site.	`new site description`
Site Type	Required	Specify the site type for the new site. . The default value is client.	`Client`
Shared Connection	Required	Specify if share connection for the new site. The default value is false.	`False`
Is Active	Required	Specify if active for the new site. The default value is true.	`True`
Time Zone	Required	Specify if Time Zone for the new site. The default value is Greenwich Mean Time.	`(GMT-08:00) Pacific Standard Time`
Language	Optional	Specify if the language for the new site. The default value is English.	`Default(English)`
Is Master	Required	Specify if it is master site for the new 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": null,
    "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	`Text`	Required	Specify the site name for the new site.
Site Description	`Text`	Optional	Specify the site description for the new site.
Site Type	`Text`	Required	Specify the site type for the new site. . The default value is client.
Shared Connection	`Text`	Required	Specify if share connection for the new site. The default value is false.
Is Active	`DateTime`	Required	Specify if active for the new site. The default value is true.
Time Zone	`DateTime`	Required	Specify if Time Zone for the new site. The default value is Greenwich Mean Time.
Language	`Text`	Optional	Specify if the language for the new site. The default value is English.
Is Master	`Text`	Required	Specify if it is master site for the new site. The default value is false.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Site Name": "sample new site",
    "Site Description": "new site description",
    "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
error	`string`	The error message if the API request has failed.
contextData	`JSON Object`	The context data from the API request.

Sample Response

JSON

{
    "error":"",
    "returnData":"Successful",
    "contextData":{
      "success": true,
      "message": null,
      "data": 100019
    }
}