Create Site‎

POST /Command/CreateSite

Create a new site

Request

Authentication: API keys or JSON web tokens (JWT)

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Site Name	`string`	Required	Specify the site name for the new site.
Site Description	`string`	Optional	Specify the site description for the new site.
Site Type	`string`	Required	Specify the site type for the new site. (Options: “Client“ or “Internal“). The default value is client.
Shared Connection	`boolean`	Required	Specify if share connection for the new site. The default value is false.
Is Active	`boolean`	Required	Specify if active for the new site. The default value is true.
Time Zone	`string`	Required	Specify if Time Zone for the new site. The default value is Greenwich Mean Time.
Language	`string`	Optional	Specify if the language for the new site. The default value is English. (Options: “Default(English)“, “Arabic“, “American“, “French“, “German“, “Portuguese“, “Spanish“, “Traditional Chinese“)
Is Master	`boolean`	Required	Specify if it is master site for the new site. The default value is false.

READER NOTE

The “Time Zone” input parameter format is (GMT±hh:mm) Time Zone Name, where GMT stands for Greenwich Mean Time, ± indicates the offset direction (ahead + or behind - GMT), and hh:mm represents the hours and minutes of the offset. For example, (GMT-12:00) International Date Line West.

Body Sample Data

application/json

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

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the command execution failed.
returnData	`string`	The return data from the API request.
contextData	`JSON Object`	The context data from the API request.
rawData	`JSON Object`	The raw data from the API request.

Sample Data

JSON

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

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}