POST /service/api/console/gsm/{gsmKey}/sites

Creates a new site under a given GSM console.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

Body Parameters

Additional information for creating the new site.

CreateGSMSiteRequestModel
NameDescriptionTypeAdditional Information
SiteName

The name of the site.

string

Required

Seats

The number of seats for the site.

integer

Required

Comments

The description for the site. Maximum of 1000 characters is allowed.

string

Required

BillingCycle

Value specifying the billing cycle. Valid values are "Annually", "Quarterly", "Monthly", or "Weekly". Default value is "Annually".

string

None.

BillingDate

Value indicating the billing date based on the specified billing cycle.

  • For "Annually" specify the desired month and day of the year in the format "MMM d" (e.g. "Aug 14")
  • For "Quarterly" specify the desired month of the quarter and the day in the format "MMM d" (e.g. "Jan 01"). Pass "Jan", "Feb", or "Mar" for the first, second, or third month in the quarter, and 1 to 28 for the desired day of the month. For example "Feb 15" indicates that the billing occurs on the 15th day in every second month of a quarter.
  • For "Monthly" just specify the desired day of the month (days 1 to 28 are allowed only)
  • For "Weekly" just specify the desired day of the week (from 1 for Monday to 7 for Sunday)
Default value is "Jan 01".

string

None.

GlobalPolicies

Value (true/false) indicating if global policies are enabled for the site. Default value is false.

boolean

None.

GlobalOverrides

Value (true/false) indicating if global overrides are enabled for the site. Default value is false.

boolean

None.

PolicyId

The identifier of the policy for the new site. If not specified, the policy "Recommended Defaults" is assigned to the site.

string

None.

Emails

Comma-separated list of e-mail addresses for report distribution. Maximum of 10 email addresses is allowed.

string

Required

Trial

Value (true/false) indicating if the type of the created keycode for the site should be a 30 day trial license. Default value is false.

boolean

None.

Modules

The list of license modules to be associated with the site.

Collection of CreateGSMSiteRequestModel_Module

None.

Sample Request

{
  "SiteName": "Test Site",
  "Seats": 50,
  "Comments": "Comment for test site",
  "BillingCycle": "Monthly",
  "BillingDate": "1",
  "GlobalPolicies": true,
  "GlobalOverrides": false,
  "PolicyId": "5e94486d-abe8-4b14-92ac-b387b316836b",
  "Emails": "test@webroot.com",
  "Trial": false,
  "Modules": [
    {
      "Type": "DNSP",
      "LicenseType": "Trial"
    },
    {
      "Type": "WSAT",
      "LicenseType": "Trial"
    }
  ]
}                    
<CreateGSMSiteRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <BillingCycle>Monthly</BillingCycle>
  <BillingDate>1</BillingDate>
  <Comments>Comment for test site</Comments>
  <Emails>test@webroot.com</Emails>
  <GlobalOverrides>false</GlobalOverrides>
  <GlobalPolicies>true</GlobalPolicies>
  <Modules>
    <CreateGSMSiteRequestModel_Module>
      <LicenseType>Trial</LicenseType>
      <Type>DNSP</Type>
    </CreateGSMSiteRequestModel_Module>
    <CreateGSMSiteRequestModel_Module>
      <LicenseType>Trial</LicenseType>
      <Type>WSAT</Type>
    </CreateGSMSiteRequestModel_Module>
  </Modules>
  <PolicyId>5e94486d-abe8-4b14-92ac-b387b316836b</PolicyId>
  <Seats>50</Seats>
  <SiteName>Test Site</SiteName>
  <Trial>false</Trial>
</CreateGSMSiteRequestModel>                    

Response Information

Resource Description

Key information about the newly created site.

CreateGSMSiteResponseModel
NameDescriptionTypeAdditional Information
KeyCode

The keycode for the created site.

string

None.

SiteId

The identifier for the created site.

string

None.

PCAccess

The PC Security Access Level for the created site. Values are 128 for admin access, 1 for view only access, 0 for no access.

integer

None.

MSAccess

The Mobile Security Access Level for the created site. Values are 128 for admin access, 1 for view only access, 0 for no access.

integer

None.

Sample Response

{
  "KeyCode": "BC91-3B6A-18E1-41D2-BBF3",
  "SiteId": "eef74e3d-8c12-4e8d-b64b-d2190f7708ba",
  "PCAccess": 128,
  "MSAccess": 1
}                    
<CreateGSMSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <KeyCode>BC91-3B6A-18E1-41D2-BBF3</KeyCode>
  <MSAccess>1</MSAccess>
  <PCAccess>128</PCAccess>
  <SiteId>eef74e3d-8c12-4e8d-b64b-d2190f7708ba</SiteId>
</CreateGSMSiteResponseModel>