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/8F8B-B45D-23D6-4172-AD7B/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": "a525f404-4993-4cbd-b9a5-a6337a9bee67",
      "SiteName": "Site 1",
      "SiteType": "R",
      "TotalEndpoints": 24,
      "PCsInfected24": 0,
      "AccountKeyCode": "06F0-EE72-79B5-4391-8194",
      "DevicesAllowed": 100,
      "MobileSeats": 5,
      "Deactivated": false,
      "Suspended": false,
      "EndDate": "2027-04-10T07:02:52.1763694Z",
      "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": "6ff0023b-9646-4815-b6f9-de5cc53911d9",
      "PolicyName": "Test policy",
      "PolicyDescription": "Sample policy for testing",
      "Emails": null,
      "AccessLevel": 128,
      "Modules": [
        {
          "Type": "DNSP",
          "LicenseType": "Trial",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "WSAT",
          "LicenseType": "Trial",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "OTEDR",
          "LicenseType": "Full",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "SAEP",
          "LicenseType": "Full",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "PLRCS",
          "LicenseType": "Full",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "PLRCB",
          "LicenseType": "Full",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "PLRM",
          "LicenseType": "Full",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "OSBPH",
          "LicenseType": "Full",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "OCEB",
          "LicenseType": "Full",
          "EndDate": "2027-04-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          },
          "Vault": "us2"
        }
      ]
    },
    {
      "SiteId": "8de5af1d-b4fb-45ff-9748-3d778c06c4ba",
      "SiteName": "Site 2",
      "SiteType": "R",
      "TotalEndpoints": 24,
      "PCsInfected24": 0,
      "AccountKeyCode": "3A4E-684E-E1A3-4E35-B0A8",
      "DevicesAllowed": 100,
      "MobileSeats": 5,
      "Deactivated": false,
      "Suspended": false,
      "EndDate": "2027-10-10T07:02:52.1763694Z",
      "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": "ad6353ee-9ad9-43ef-a274-93ae374a9a90",
      "PolicyName": "Test policy",
      "PolicyDescription": "Sample policy for testing",
      "Emails": null,
      "AccessLevel": 128,
      "Modules": [
        {
          "Type": "DNSP",
          "LicenseType": "Trial",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "WSAT",
          "LicenseType": "Trial",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "OTMDRC",
          "LicenseType": "Full",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "SAEP",
          "LicenseType": "Full",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "PLRCS",
          "LicenseType": "Full",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "PLRCB",
          "LicenseType": "Full",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "PLRM",
          "LicenseType": "Full",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "OSBPH",
          "LicenseType": "Full",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          }
        },
        {
          "Type": "OCEB",
          "LicenseType": "Full",
          "EndDate": "2027-10-10T07:02:52.1763694Z",
          "ProvisioningStatus": {
            "Status": "Success"
          },
          "Vault": "us2"
        }
      ]
    }
  ]
}

<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>06F0-EE72-79B5-4391-8194</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>2027-04-10T07:02:52.1763694Z</EndDate>
      <GlobalAlerts>true</GlobalAlerts>
      <GlobalOverrides>true</GlobalOverrides>
      <GlobalPolicies>true</GlobalPolicies>
      <Infect>false</Infect>
      <MobileSeats>5</MobileSeats>
      <Modules>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>DNSP</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>WSAT</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>OTEDR</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>SAEP</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>PLRCS</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>PLRCB</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>PLRM</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>OSBPH</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-04-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>OCEB</Type>
          <Vault>us2</Vault>
        </GetGSMSitesResponseModel_Module>
      </Modules>
      <PCsInfected24>0</PCsInfected24>
      <PolicyDescription>Sample policy for testing</PolicyDescription>
      <PolicyId>6ff0023b-9646-4815-b6f9-de5cc53911d9</PolicyId>
      <PolicyName>Test policy</PolicyName>
      <SiteId>a525f404-4993-4cbd-b9a5-a6337a9bee67</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>3A4E-684E-E1A3-4E35-B0A8</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>2027-10-10T07:02:52.1763694Z</EndDate>
      <GlobalAlerts>true</GlobalAlerts>
      <GlobalOverrides>true</GlobalOverrides>
      <GlobalPolicies>true</GlobalPolicies>
      <Infect>false</Infect>
      <MobileSeats>5</MobileSeats>
      <Modules>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>DNSP</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Trial</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>WSAT</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>OTMDRC</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>SAEP</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>PLRCS</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>PLRCB</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>PLRM</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>OSBPH</Type>
          <Vault i:nil="true" />
        </GetGSMSitesResponseModel_Module>
        <GetGSMSitesResponseModel_Module>
          <EndDate>2027-10-10T07:02:52.1763694Z</EndDate>
          <LicenseType>Full</LicenseType>
          <ProvisioningStatus>
            <ErrorMessage i:nil="true" />
            <Status>Success</Status>
          </ProvisioningStatus>
          <Type>OCEB</Type>
          <Vault>us2</Vault>
        </GetGSMSitesResponseModel_Module>
      </Modules>
      <PCsInfected24>0</PCsInfected24>
      <PolicyDescription>Sample policy for testing</PolicyDescription>
      <PolicyId>ad6353ee-9ad9-43ef-a274-93ae374a9a90</PolicyId>
      <PolicyName>Test policy</PolicyName>
      <SiteId>8de5af1d-b4fb-45ff-9748-3d778c06c4ba</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>