GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/policies/{policyId}
Gets information about a site policy.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
| siteId |
The site identifier. |
string |
Required |
| policyId |
The identifier of the policy to query information for. |
string |
Required |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/891C-932B-9E80-4113-AC9C/sites/f3ac86a5-e863-4dbb-9976-da001c9d75c6/policies/0cc454fa-1988-42ce-a150-3c7d6e6d5821
|
Body Parameters
None.
Response Information
Resource Description
Information about the desired site policy.
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": 1,
"Deleted": false,
"Policies": [
{
"PolicyId": "818f7a12-ea96-4b75-9174-61b091009c28",
"DateCreated": "2025-09-06T19:08:39.8332021Z",
"PolicyName": "Test Policy 1",
"LivePolicy": true,
"PendingPolicy": false,
"PolicyDescription": "Description of test policy 1",
"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-06T19:08:39.8332021Z</DateCreated>
<DefaultSetting>false</DefaultSetting>
<Deleted>false</Deleted>
<GlobalPolicy>false</GlobalPolicy>
<LivePolicy>true</LivePolicy>
<PendingPolicy>false</PendingPolicy>
<PolicyDescription>Description of test policy 1</PolicyDescription>
<PolicyId>818f7a12-ea96-4b75-9174-61b091009c28</PolicyId>
<PolicyName>Test Policy 1</PolicyName>
<PolicyType>Advanced</PolicyType>
</GetGSMSitePoliciesResponseModel_Policy>
</Policies>
<TotalCount>1</TotalCount>
</GetGSMSitePoliciesResponseModel>