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/49F3-26E7-1DC0-42AA-A29A/sites/67f0872b-aa3c-4d8a-83ed-5254c4fd72f6/policies/7489d97c-5320-4bf8-b6d3-338eebfba904
|
Body Parameters
None.
Response Information
Resource Description
Information about the desired site policy.
GetGSMSitePoliciesResponseModelName | 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": "7b9b59a6-487f-482f-9e38-bc751a765938", "DateCreated": "2022-12-09T05:42:55.8802231Z", "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>2022-12-09T05:42:55.8802231Z</DateCreated> <DefaultSetting>false</DefaultSetting> <Deleted>false</Deleted> <GlobalPolicy>false</GlobalPolicy> <LivePolicy>true</LivePolicy> <PendingPolicy>false</PendingPolicy> <PolicyDescription>Description of test policy 1</PolicyDescription> <PolicyId>7b9b59a6-487f-482f-9e38-bc751a765938</PolicyId> <PolicyName>Test Policy 1</PolicyName> <PolicyType>Advanced</PolicyType> </GetGSMSitePoliciesResponseModel_Policy> </Policies> <TotalCount>1</TotalCount> </GetGSMSitePoliciesResponseModel>