PUT /service/api/console/gsm/{gsmKey}/sites/{siteId}
Edits information for a site under a given GSM console.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
| siteId |
The site identifier. |
string |
Required |
URI Sample(s)
|
PUT
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/F021-8B66-3423-498D-9D9E/sites/7858c8fa-0167-4fbb-8f84-8b3a7db1402e
|
Body Parameters
Additional information about which values should be modified for the site.
EditGSMSiteRequestModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| SiteName |
The name of the site. |
string |
None. |
| Seats |
The number of seats for the site. |
integer |
None. |
| Comments |
The description for the site. Maximum of 1000 characters is allowed. |
string |
None. |
| BillingCycle |
Value specifying the billing cycle. Valid values are "Annually", "Quarterly", "Monthly", or "Weekly". |
string |
None. |
| BillingDate |
Value indicating the billing date based on the specified billing cycle.
|
string |
None. |
| GlobalPolicies |
Value (true/false) indicating if global policies are enabled for the site. |
boolean |
None. |
| GlobalOverrides |
Value (true/false) indicating if global overrides are enabled for the site. |
boolean |
None. |
| PolicyId |
The policy identifier. |
string |
None. |
| Emails |
Comma-separated list of e-mail addresses for report distribution. Maximum of 10 email addresses is allowed. |
string |
None. |
| Modules |
The list of license modules to be changed for the site. |
Collection of EditGSMSiteRequestModel_Module |
None. |
Sample Request
{
"SiteName": "Renamed Test Site",
"Seats": 50,
"Comments": "Comment for renamed test site",
"BillingCycle": "Monthly",
"BillingDate": "1",
"GlobalPolicies": true,
"GlobalOverrides": false,
"PolicyId": "7d68578f-9453-4fdf-acfe-ddc2cb54aba0",
"Emails": "test@webroot.com",
"Modules": [
{
"Type": "DNSP",
"LicenseType": "Trial",
"Enable": true
},
{
"Type": "WSAT",
"LicenseType": "Trial",
"Enable": true
},
{
"Type": "OTEDR",
"LicenseType": "Full",
"Enable": true
},
{
"Type": "SAEP",
"LicenseType": "Full",
"Enable": true
},
{
"Type": "PLRCS",
"LicenseType": "Full",
"Enable": true
},
{
"Type": "PLRCB",
"LicenseType": "Full",
"Enable": true
},
{
"Type": "PLRM",
"LicenseType": "Full",
"Enable": true
}
]
}
<EditGSMSiteRequestModel 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 renamed test site</Comments>
<Emails>test@webroot.com</Emails>
<GlobalOverrides>false</GlobalOverrides>
<GlobalPolicies>true</GlobalPolicies>
<Modules>
<EditGSMSiteRequestModel_Module>
<Enable>true</Enable>
<LicenseType>Trial</LicenseType>
<Type>DNSP</Type>
</EditGSMSiteRequestModel_Module>
<EditGSMSiteRequestModel_Module>
<Enable>true</Enable>
<LicenseType>Trial</LicenseType>
<Type>WSAT</Type>
</EditGSMSiteRequestModel_Module>
<EditGSMSiteRequestModel_Module>
<Enable>true</Enable>
<LicenseType>Full</LicenseType>
<Type>OTEDR</Type>
</EditGSMSiteRequestModel_Module>
<EditGSMSiteRequestModel_Module>
<Enable>true</Enable>
<LicenseType>Full</LicenseType>
<Type>SAEP</Type>
</EditGSMSiteRequestModel_Module>
<EditGSMSiteRequestModel_Module>
<Enable>true</Enable>
<LicenseType>Full</LicenseType>
<Type>PLRCS</Type>
</EditGSMSiteRequestModel_Module>
<EditGSMSiteRequestModel_Module>
<Enable>true</Enable>
<LicenseType>Full</LicenseType>
<Type>PLRCB</Type>
</EditGSMSiteRequestModel_Module>
<EditGSMSiteRequestModel_Module>
<Enable>true</Enable>
<LicenseType>Full</LicenseType>
<Type>PLRM</Type>
</EditGSMSiteRequestModel_Module>
</Modules>
<PolicyId>7d68578f-9453-4fdf-acfe-ddc2cb54aba0</PolicyId>
<Seats>50</Seats>
<SiteName>Renamed Test Site</SiteName>
</EditGSMSiteRequestModel>
Response Information
Resource Description
None. If successful, this API action does not return any data and the response status code will be 204 (No Content).