GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/policies
Gets the list of policies on a given GSM site.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
| siteId |
The site identifier. |
string |
Required |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/D501-9302-5506-494C-BFCD/sites/a0bb8e25-db3d-4099-838b-841eef113abb/policies
|
Body Parameters
None.
Response Information
Resource Description
Information about the list of policies available on a given GSM site.
GetGSMSitePoliciesResponseModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| TotalCount |
Total number of policies available. |
integer |
None. |
| Deleted |
Value (true/false) indicating whether any policy has been deleted. |
boolean |
None. |
| Policies |
List of policy details records. |
Collection of GetGSMSitePoliciesResponseModel_Policy |
None. |
Sample Response
{
"TotalCount": 2,
"Deleted": false,
"Policies": [
{
"PolicyId": "40609e09-f6f9-46fe-8bf7-5557f7478fd3",
"DateCreated": "2025-09-27T07:19:46.198903Z",
"PolicyName": "Test Policy 1",
"LivePolicy": true,
"PendingPolicy": false,
"PolicyDescription": "Description of test policy 1",
"Deleted": false,
"Canned": false,
"DefaultSetting": false,
"GlobalPolicy": false,
"PolicyType": "Advanced"
},
{
"PolicyId": "f9da9de3-68d9-490f-aa0d-c2585ba172cf",
"DateCreated": "2025-07-27T07:19:46.198903Z",
"PolicyName": "Test Policy 2",
"LivePolicy": true,
"PendingPolicy": false,
"PolicyDescription": "Description of test policy 2",
"Deleted": false,
"Canned": false,
"DefaultSetting": false,
"GlobalPolicy": false,
"PolicyType": "Advanced"
}
]
}
<GetGSMSitePoliciesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
<Deleted>false</Deleted>
<Policies>
<GetGSMSitePoliciesResponseModel_Policy>
<Canned>false</Canned>
<DateCreated>2025-09-27T07:19:46.198903Z</DateCreated>
<DefaultSetting>false</DefaultSetting>
<Deleted>false</Deleted>
<GlobalPolicy>false</GlobalPolicy>
<LivePolicy>true</LivePolicy>
<PendingPolicy>false</PendingPolicy>
<PolicyDescription>Description of test policy 1</PolicyDescription>
<PolicyId>40609e09-f6f9-46fe-8bf7-5557f7478fd3</PolicyId>
<PolicyName>Test Policy 1</PolicyName>
<PolicyType>Advanced</PolicyType>
</GetGSMSitePoliciesResponseModel_Policy>
<GetGSMSitePoliciesResponseModel_Policy>
<Canned>false</Canned>
<DateCreated>2025-07-27T07:19:46.198903Z</DateCreated>
<DefaultSetting>false</DefaultSetting>
<Deleted>false</Deleted>
<GlobalPolicy>false</GlobalPolicy>
<LivePolicy>true</LivePolicy>
<PendingPolicy>false</PendingPolicy>
<PolicyDescription>Description of test policy 2</PolicyDescription>
<PolicyId>f9da9de3-68d9-490f-aa0d-c2585ba172cf</PolicyId>
<PolicyName>Test Policy 2</PolicyName>
<PolicyType>Advanced</PolicyType>
</GetGSMSitePoliciesResponseModel_Policy>
</Policies>
<TotalCount>2</TotalCount>
</GetGSMSitePoliciesResponseModel>