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/EFF0-FBAB-FD74-4032-9795/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": "515810bf-4ec1-46a7-9e64-177440e4ad2d",
"SiteName": "Site 1",
"SiteType": "R",
"TotalEndpoints": 24,
"PCsInfected24": 0,
"AccountKeyCode": "B969-40D5-18B6-4312-9448",
"DevicesAllowed": 100,
"MobileSeats": 5,
"Deactivated": false,
"Suspended": false,
"EndDate": "2024-03-30T16:18:13.1266368Z",
"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": "2b6aaf9f-8061-490e-b9f4-3c3dc37d5d4f",
"PolicyName": "Test policy",
"PolicyDescription": "Sample policy for testing",
"Emails": null,
"AccessLevel": 128,
"Modules": [
{
"Type": "DNSP",
"LicenseType": "Trial",
"EndDate": "2024-03-30T16:18:13.1266368Z"
},
{
"Type": "WSAT",
"LicenseType": "Trial",
"EndDate": "2024-03-30T16:18:13.1266368Z"
}
]
},
{
"SiteId": "df27d881-74fc-4bac-abdf-d302c85f1618",
"SiteName": "Site 2",
"SiteType": "R",
"TotalEndpoints": 24,
"PCsInfected24": 0,
"AccountKeyCode": "0E92-A6EA-6AE3-424F-AFB3",
"DevicesAllowed": 100,
"MobileSeats": 5,
"Deactivated": false,
"Suspended": false,
"EndDate": "2024-09-30T16:18:13.1266368Z",
"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": "1eec4152-a9dd-4945-93b7-0cf4ed733901",
"PolicyName": "Test policy",
"PolicyDescription": "Sample policy for testing",
"Emails": null,
"AccessLevel": 128,
"Modules": [
{
"Type": "DNSP",
"LicenseType": "Trial",
"EndDate": "2024-09-30T16:18:13.1266368Z"
},
{
"Type": "WSAT",
"LicenseType": "Trial",
"EndDate": "2024-09-30T16:18:13.1266368Z"
}
]
}
]
}
<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>B969-40D5-18B6-4312-9448</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>2024-03-30T16:18:13.1266368Z</EndDate>
<GlobalAlerts>true</GlobalAlerts>
<GlobalOverrides>true</GlobalOverrides>
<GlobalPolicies>true</GlobalPolicies>
<Infect>false</Infect>
<MobileSeats>5</MobileSeats>
<Modules>
<GetGSMSitesResponseModel_Module>
<EndDate>2024-03-30T16:18:13.1266368Z</EndDate>
<LicenseType>Trial</LicenseType>
<Type>DNSP</Type>
</GetGSMSitesResponseModel_Module>
<GetGSMSitesResponseModel_Module>
<EndDate>2024-03-30T16:18:13.1266368Z</EndDate>
<LicenseType>Trial</LicenseType>
<Type>WSAT</Type>
</GetGSMSitesResponseModel_Module>
</Modules>
<PCsInfected24>0</PCsInfected24>
<PolicyDescription>Sample policy for testing</PolicyDescription>
<PolicyId>2b6aaf9f-8061-490e-b9f4-3c3dc37d5d4f</PolicyId>
<PolicyName>Test policy</PolicyName>
<SiteId>515810bf-4ec1-46a7-9e64-177440e4ad2d</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>0E92-A6EA-6AE3-424F-AFB3</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>2024-09-30T16:18:13.1266368Z</EndDate>
<GlobalAlerts>true</GlobalAlerts>
<GlobalOverrides>true</GlobalOverrides>
<GlobalPolicies>true</GlobalPolicies>
<Infect>false</Infect>
<MobileSeats>5</MobileSeats>
<Modules>
<GetGSMSitesResponseModel_Module>
<EndDate>2024-09-30T16:18:13.1266368Z</EndDate>
<LicenseType>Trial</LicenseType>
<Type>DNSP</Type>
</GetGSMSitesResponseModel_Module>
<GetGSMSitesResponseModel_Module>
<EndDate>2024-09-30T16:18:13.1266368Z</EndDate>
<LicenseType>Trial</LicenseType>
<Type>WSAT</Type>
</GetGSMSitesResponseModel_Module>
</Modules>
<PCsInfected24>0</PCsInfected24>
<PolicyDescription>Sample policy for testing</PolicyDescription>
<PolicyId>1eec4152-a9dd-4945-93b7-0cf4ed733901</PolicyId>
<PolicyName>Test policy</PolicyName>
<SiteId>df27d881-74fc-4bac-abdf-d302c85f1618</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>