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/B41B-E8A4-56FA-46B8-8767/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": "581a618d-4b76-4f0c-9294-23c17519e894", "SiteName": "Site 1", "SiteType": "R", "TotalEndpoints": 24, "PCsInfected24": 0, "AccountKeyCode": "62AF-EF4C-CCB0-495D-AE5E", "DevicesAllowed": 100, "MobileSeats": 5, "Deactivated": false, "Suspended": false, "EndDate": "2025-11-09T04:31:36.0990472Z", "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": "dda47843-d687-4129-b82e-0a30221fc095", "PolicyName": "Test policy", "PolicyDescription": "Sample policy for testing", "Emails": null, "AccessLevel": 128, "Modules": [ { "Type": "DNSP", "LicenseType": "Trial", "EndDate": "2025-11-09T04:31:36.0990472Z" }, { "Type": "WSAT", "LicenseType": "Trial", "EndDate": "2025-11-09T04:31:36.0990472Z" }, { "Type": "OTEDR", "LicenseType": "Full", "EndDate": "2025-11-09T04:31:36.0990472Z" }, { "Type": "SAEP", "LicenseType": "Full", "EndDate": "2025-11-09T04:31:36.0990472Z" }, { "Type": "PLRCS", "LicenseType": "Full", "EndDate": "2025-11-09T04:31:36.0990472Z" } ] }, { "SiteId": "fec5b003-5dbd-476b-b44e-983174ab5b49", "SiteName": "Site 2", "SiteType": "R", "TotalEndpoints": 24, "PCsInfected24": 0, "AccountKeyCode": "4E74-3FF6-5535-453D-AF9D", "DevicesAllowed": 100, "MobileSeats": 5, "Deactivated": false, "Suspended": false, "EndDate": "2026-05-09T04:31:36.0990472Z", "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": "e31ef4c1-7d81-45a5-80db-c7c39da6a459", "PolicyName": "Test policy", "PolicyDescription": "Sample policy for testing", "Emails": null, "AccessLevel": 128, "Modules": [ { "Type": "DNSP", "LicenseType": "Trial", "EndDate": "2026-05-09T04:31:36.0990472Z" }, { "Type": "WSAT", "LicenseType": "Trial", "EndDate": "2026-05-09T04:31:36.0990472Z" }, { "Type": "OTEDR", "LicenseType": "Full", "EndDate": "2026-05-09T04:31:36.0990472Z" }, { "Type": "SAEP", "LicenseType": "Full", "EndDate": "2026-05-09T04:31:36.0990472Z" }, { "Type": "PLRCS", "LicenseType": "Full", "EndDate": "2026-05-09T04:31:36.0990472Z" } ] } ] }
<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>62AF-EF4C-CCB0-495D-AE5E</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-09T04:31:36.0990472Z</EndDate> <GlobalAlerts>true</GlobalAlerts> <GlobalOverrides>true</GlobalOverrides> <GlobalPolicies>true</GlobalPolicies> <Infect>false</Infect> <MobileSeats>5</MobileSeats> <Modules> <GetGSMSitesResponseModel_Module> <EndDate>2025-11-09T04:31:36.0990472Z</EndDate> <LicenseType>Trial</LicenseType> <Type>DNSP</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2025-11-09T04:31:36.0990472Z</EndDate> <LicenseType>Trial</LicenseType> <Type>WSAT</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2025-11-09T04:31:36.0990472Z</EndDate> <LicenseType>Full</LicenseType> <Type>OTEDR</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2025-11-09T04:31:36.0990472Z</EndDate> <LicenseType>Full</LicenseType> <Type>SAEP</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2025-11-09T04:31:36.0990472Z</EndDate> <LicenseType>Full</LicenseType> <Type>PLRCS</Type> </GetGSMSitesResponseModel_Module> </Modules> <PCsInfected24>0</PCsInfected24> <PolicyDescription>Sample policy for testing</PolicyDescription> <PolicyId>dda47843-d687-4129-b82e-0a30221fc095</PolicyId> <PolicyName>Test policy</PolicyName> <SiteId>581a618d-4b76-4f0c-9294-23c17519e894</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>4E74-3FF6-5535-453D-AF9D</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>2026-05-09T04:31:36.0990472Z</EndDate> <GlobalAlerts>true</GlobalAlerts> <GlobalOverrides>true</GlobalOverrides> <GlobalPolicies>true</GlobalPolicies> <Infect>false</Infect> <MobileSeats>5</MobileSeats> <Modules> <GetGSMSitesResponseModel_Module> <EndDate>2026-05-09T04:31:36.0990472Z</EndDate> <LicenseType>Trial</LicenseType> <Type>DNSP</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2026-05-09T04:31:36.0990472Z</EndDate> <LicenseType>Trial</LicenseType> <Type>WSAT</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2026-05-09T04:31:36.0990472Z</EndDate> <LicenseType>Full</LicenseType> <Type>OTEDR</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2026-05-09T04:31:36.0990472Z</EndDate> <LicenseType>Full</LicenseType> <Type>SAEP</Type> </GetGSMSitesResponseModel_Module> <GetGSMSitesResponseModel_Module> <EndDate>2026-05-09T04:31:36.0990472Z</EndDate> <LicenseType>Full</LicenseType> <Type>PLRCS</Type> </GetGSMSitesResponseModel_Module> </Modules> <PCsInfected24>0</PCsInfected24> <PolicyDescription>Sample policy for testing</PolicyDescription> <PolicyId>e31ef4c1-7d81-45a5-80db-c7c39da6a459</PolicyId> <PolicyName>Test policy</PolicyName> <SiteId>fec5b003-5dbd-476b-b44e-983174ab5b49</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>