GET /service/api/console/gsm/{gsmKey}/sites
Gets the list of sites associated with a given GSM console.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/6682-A6CA-F8B8-40D9-9BE0/sites
|
Body Parameters
None.
Response Information
Resource Description
Information about the list of sites associated with a given GSM console.
GetGSMSitesResponseModelName | Description | Type | Additional Information |
---|---|---|---|
TotalSeatsAllowed |
The total number of Parent Keycode Site Seats/devices purchased. |
integer |
None. |
ParentDescription |
Indicates if parent key is a "Full" or "Trial" license. |
string |
None. |
SumTotalDevices |
The total number of Active Devices installed on the GSM sites. |
integer |
None. |
SumTotalDevicesAllowed |
The total number of Site Seats allocated to all GSM sites. |
integer |
None. |
SumTotalDevicesNotTrial |
The total number of Site Seats allocated to all GSM sites which are not trial sites. |
integer |
None. |
SumTotalMobileDevicesAllowed |
The total number of mobile Site Seats allocated to the GSM sites. |
integer |
None. |
TotalCount |
The total number of sites under the GSM. |
integer |
None. |
Sites |
List of site details records. |
Collection of GetGSMSitesResponseModel_Site |
None. |
Sample Response
{ "TotalSeatsAllowed": 250, "ParentDescription": "Full", "SumTotalDevices": 57, "SumTotalDevicesAllowed": 200, "SumTotalDevicesNotTrial": 200, "SumTotalMobileDevicesAllowed": 50, "TotalCount": 2, "Sites": [ { "SiteId": "de4e4ba9-3ace-4b5a-b89d-2df48ce9bab9", "SiteName": "Site 1", "SiteType": "R", "TotalEndpoints": 24, "PCsInfected24": 0, "AccountKeyCode": "1D16-12BA-7DA4-4909-80AA", "DevicesAllowed": 100, "MobileSeats": 5, "Deactivated": false, "Suspended": false, "EndDate": "2025-05-28T03:47:15.1500816Z", "Device": true, "Infect": false, "BillingCycle": "Anually", "BillingDate": "Jan 01", "CompanyComments": "", "DeactivatedBy": null, "SuspendedBy": null, "CreatedBy": "test@webroot.com", "GlobalPolicies": true, "GlobalOverrides": true, "GlobalAlerts": true, "AllKeysExpired": false, "Description": "Full", "PolicyId": "0b4ed957-7f73-4b7e-85f7-c4164c27fc67", "PolicyName": "Test policy", "PolicyDescription": "Sample policy for testing", "Emails": null, "AccessLevel": 128, "Modules": [ { "Type": "DNSP", "LicenseType": "Trial", "EndDate": "2025-05-28T03:47:15.1500816Z" }, { "Type": "WSAT", "LicenseType": "Trial", "EndDate": "2025-05-28T03:47:15.1500816Z" } ] }, { "SiteId": "fff9203e-40c7-4cb8-963e-48d67069c2eb", "SiteName": "Site 2", "SiteType": "R", "TotalEndpoints": 24, "PCsInfected24": 0, "AccountKeyCode": "EED6-7032-DA84-4B75-8538", "DevicesAllowed": 100, "MobileSeats": 5, "Deactivated": false, "Suspended": false, "EndDate": "2025-11-28T03:47:15.1500816Z", "Device": true, "Infect": false, "BillingCycle": "Anually", "BillingDate": "Jan 01", "CompanyComments": "", "DeactivatedBy": null, "SuspendedBy": null, "CreatedBy": "test@webroot.com", "GlobalPolicies": true, "GlobalOverrides": true, "GlobalAlerts": true, "AllKeysExpired": false, "Description": "Full", "PolicyId": "2b709a4d-9759-4f24-9447-7aff2808b4c5", "PolicyName": "Test policy", "PolicyDescription": "Sample policy for testing", "Emails": null, "AccessLevel": 128, "Modules": [ { "Type": "DNSP", "LicenseType": "Trial", "EndDate": "2025-11-28T03:47:15.1500816Z" }, { "Type": "WSAT", "LicenseType": "Trial", "EndDate": "2025-11-28T03:47:15.1500816Z" } ] } ] }
<GetGSMSitesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <ParentDescription>Full</ParentDescription> <Sites> <GetGSMSitesResponseModel_Site> <AccessLevel>128</AccessLevel> <AccountKeyCode>1D16-12BA-7DA4-4909-80AA</AccountKeyCode> <AllKeysExpired>false</AllKeysExpired> <BillingCycle>Anually</BillingCycle> <BillingDate>Jan 01</BillingDate> <CompanyComments></CompanyComments> <CreatedBy>test@webroot.com</CreatedBy> <Deactivated>false</Deactivated> <DeactivatedBy i:nil="true" /> <Description>Full</Description> <Device>true</Device> <DevicesAllowed>100</DevicesAllowed> <Emails i:nil="true" /> <EndDate>2025-05-28T03:47:15.1500816Z</EndDate> <GlobalAlerts>true</GlobalAlerts> <GlobalOverrides>true</GlobalOverrides> <GlobalPolicies>true</GlobalPolicies> <Infect>false</Infect> <MobileSeats>5</MobileSeats> <Modules> <GetGSMSitesResponseModel_Module> <EndDate>2025-05-28T03:47:15.1500816Z</EndDate> <LicenseType>Trial</LicenseType> <Type>DNSP</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2025-05-28T03:47:15.1500816Z</EndDate> <LicenseType>Trial</LicenseType> <Type>WSAT</Type> </GetGSMSitesResponseModel_Module> </Modules> <PCsInfected24>0</PCsInfected24> <PolicyDescription>Sample policy for testing</PolicyDescription> <PolicyId>0b4ed957-7f73-4b7e-85f7-c4164c27fc67</PolicyId> <PolicyName>Test policy</PolicyName> <SiteId>de4e4ba9-3ace-4b5a-b89d-2df48ce9bab9</SiteId> <SiteName>Site 1</SiteName> <SiteType>R</SiteType> <Suspended>false</Suspended> <SuspendedBy i:nil="true" /> <TotalEndpoints>24</TotalEndpoints> </GetGSMSitesResponseModel_Site> <GetGSMSitesResponseModel_Site> <AccessLevel>128</AccessLevel> <AccountKeyCode>EED6-7032-DA84-4B75-8538</AccountKeyCode> <AllKeysExpired>false</AllKeysExpired> <BillingCycle>Anually</BillingCycle> <BillingDate>Jan 01</BillingDate> <CompanyComments></CompanyComments> <CreatedBy>test@webroot.com</CreatedBy> <Deactivated>false</Deactivated> <DeactivatedBy i:nil="true" /> <Description>Full</Description> <Device>true</Device> <DevicesAllowed>100</DevicesAllowed> <Emails i:nil="true" /> <EndDate>2025-11-28T03:47:15.1500816Z</EndDate> <GlobalAlerts>true</GlobalAlerts> <GlobalOverrides>true</GlobalOverrides> <GlobalPolicies>true</GlobalPolicies> <Infect>false</Infect> <MobileSeats>5</MobileSeats> <Modules> <GetGSMSitesResponseModel_Module> <EndDate>2025-11-28T03:47:15.1500816Z</EndDate> <LicenseType>Trial</LicenseType> <Type>DNSP</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2025-11-28T03:47:15.1500816Z</EndDate> <LicenseType>Trial</LicenseType> <Type>WSAT</Type> </GetGSMSitesResponseModel_Module> </Modules> <PCsInfected24>0</PCsInfected24> <PolicyDescription>Sample policy for testing</PolicyDescription> <PolicyId>2b709a4d-9759-4f24-9447-7aff2808b4c5</PolicyId> <PolicyName>Test policy</PolicyName> <SiteId>fff9203e-40c7-4cb8-963e-48d67069c2eb</SiteId> <SiteName>Site 2</SiteName> <SiteType>R</SiteType> <Suspended>false</Suspended> <SuspendedBy i:nil="true" /> <TotalEndpoints>24</TotalEndpoints> </GetGSMSitesResponseModel_Site> </Sites> <SumTotalDevices>57</SumTotalDevices> <SumTotalDevicesAllowed>200</SumTotalDevicesAllowed> <SumTotalDevicesNotTrial>200</SumTotalDevicesNotTrial> <SumTotalMobileDevicesAllowed>50</SumTotalMobileDevicesAllowed> <TotalCount>2</TotalCount> <TotalSeatsAllowed>250</TotalSeatsAllowed> </GetGSMSitesResponseModel>