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/FB02-67E1-C1D3-4971-ADBA/sites

Body Parameters

None.

Response Information

Resource Description

Information about the list of sites associated with a given GSM console.

GetGSMSitesResponseModel

Name	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": "bace5eba-67a4-4376-aad6-245ad618ec00",
      "SiteName": "Site 1",
      "SiteType": "R",
      "TotalEndpoints": 24,
      "PCsInfected24": 0,
      "AccountKeyCode": "2C4F-54A2-7684-4D9B-94A1",
      "DevicesAllowed": 100,
      "MobileSeats": 5,
      "Deactivated": false,
      "Suspended": false,
      "EndDate": "2026-04-30T20:08:25.3154487Z",
      "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": "9fb9b273-9f18-4f09-85a0-c9f30b0fc127",
      "PolicyName": "Test policy",
      "PolicyDescription": "Sample policy for testing",
      "Emails": null,
      "AccessLevel": 128,
      "Modules": [
        {
          "Type": "DNSP",
          "LicenseType": "Trial",
          "EndDate": "2026-04-30T20:08:25.3154487Z"
        },
        {
          "Type": "WSAT",
          "LicenseType": "Trial",
          "EndDate": "2026-04-30T20:08:25.3154487Z"
        },
        {
          "Type": "OTEDR",
          "LicenseType": "Full",
          "EndDate": "2026-04-30T20:08:25.3154487Z"
        },
        {
          "Type": "SAEP",
          "LicenseType": "Full",
          "EndDate": "2026-04-30T20:08:25.3154487Z"
        },
        {
          "Type": "PLRCS",
          "LicenseType": "Full",
          "EndDate": "2026-04-30T20:08:25.3154487Z"
        },
        {
          "Type": "PLRCB",
          "LicenseType": "Full",
          "EndDate": "2026-04-30T20:08:25.3154487Z"
        },
        {
          "Type": "PLRM",
          "LicenseType": "Full",
          "EndDate": "2026-04-30T20:08:25.3154487Z"
        }
      ]
    },
    {
      "SiteId": "b50358d5-ab68-4c09-9a20-29a018342a1b",
      "SiteName": "Site 2",
      "SiteType": "R",
      "TotalEndpoints": 24,
      "PCsInfected24": 0,
      "AccountKeyCode": "E0B3-8FD6-FE74-497E-9E36",
      "DevicesAllowed": 100,
      "MobileSeats": 5,
      "Deactivated": false,
      "Suspended": false,
      "EndDate": "2026-10-30T20:08:25.3154487Z",
      "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": "f2cb439e-38b2-4a1c-b50d-e7bf03d90432",
      "PolicyName": "Test policy",
      "PolicyDescription": "Sample policy for testing",
      "Emails": null,
      "AccessLevel": 128,
      "Modules": [
        {
          "Type": "DNSP",
          "LicenseType": "Trial",
          "EndDate": "2026-10-30T20:08:25.3154487Z"
        },
        {
          "Type": "WSAT",
          "LicenseType": "Trial",
          "EndDate": "2026-10-30T20:08:25.3154487Z"
        },
        {
          "Type": "OTEDR",
          "LicenseType": "Full",
          "EndDate": "2026-10-30T20:08:25.3154487Z"
        },
        {
          "Type": "SAEP",
          "LicenseType": "Full",
          "EndDate": "2026-10-30T20:08:25.3154487Z"
        },
        {
          "Type": "PLRCS",
          "LicenseType": "Full",
          "EndDate": "2026-10-30T20:08:25.3154487Z"
        },
        {
          "Type": "PLRCB",
          "LicenseType": "Full",
          "EndDate": "2026-10-30T20:08:25.3154487Z"
        },
        {
          "Type": "PLRM",
          "LicenseType": "Full",
          "EndDate": "2026-10-30T20:08:25.3154487Z"
        }
      ]
    }
  ]
}

<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>2C4F-54A2-7684-4D9B-94A1</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-04-30T20:08:25.3154487Z</EndDate>
      <GlobalAlerts>true</GlobalAlerts>
      <GlobalOverrides>true</GlobalOverrides>
      <GlobalPolicies>true</GlobalPolicies>
      <Infect>false</Infect>
      <MobileSeats>5</MobileSeats>
      <Modules>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-04-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <Type>DNSP</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-04-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <Type>WSAT</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-04-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>OTEDR</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-04-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>SAEP</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-04-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>PLRCS</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-04-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>PLRCB</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-04-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>PLRM</Type>
        </GetGSMSitesResponseModel_Module>
      </Modules>
      <PCsInfected24>0</PCsInfected24>
      <PolicyDescription>Sample policy for testing</PolicyDescription>
      <PolicyId>9fb9b273-9f18-4f09-85a0-c9f30b0fc127</PolicyId>
      <PolicyName>Test policy</PolicyName>
      <SiteId>bace5eba-67a4-4376-aad6-245ad618ec00</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>E0B3-8FD6-FE74-497E-9E36</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-10-30T20:08:25.3154487Z</EndDate>
      <GlobalAlerts>true</GlobalAlerts>
      <GlobalOverrides>true</GlobalOverrides>
      <GlobalPolicies>true</GlobalPolicies>
      <Infect>false</Infect>
      <MobileSeats>5</MobileSeats>
      <Modules>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-10-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <Type>DNSP</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-10-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <Type>WSAT</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-10-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>OTEDR</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-10-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>SAEP</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-10-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>PLRCS</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-10-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>PLRCB</Type>
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2026-10-30T20:08:25.3154487Z</EndDate>
          <LicenseType>Full</LicenseType>
          <Type>PLRM</Type>
        </GetGSMSitesResponseModel_Module>
      </Modules>
      <PCsInfected24>0</PCsInfected24>
      <PolicyDescription>Sample policy for testing</PolicyDescription>
      <PolicyId>f2cb439e-38b2-4a1c-b50d-e7bf03d90432</PolicyId>
      <PolicyName>Test policy</PolicyName>
      <SiteId>b50358d5-ab68-4c09-9a20-29a018342a1b</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>