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/D2D2-E27E-18B8-46D8-87F5/sites/7475ba7b-04cb-4c9a-8773-dbcc78a88fb8/policies
|
Body Parameters
None.
Response Information
Resource Description
Information about the list of policies available on a given GSM site.
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": 2, "Deleted": false, "Policies": [ { "PolicyId": "e1ee9345-b89f-462c-bcf0-713cf67fab8e", "DateCreated": "2024-07-09T08:38:25.3384048Z", "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": "bb28c794-3507-4324-ae4c-9949047a9025", "DateCreated": "2024-05-09T08:38:25.3384048Z", "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>2024-07-09T08:38:25.3384048Z</DateCreated> <DefaultSetting>false</DefaultSetting> <Deleted>false</Deleted> <GlobalPolicy>false</GlobalPolicy> <LivePolicy>true</LivePolicy> <PendingPolicy>false</PendingPolicy> <PolicyDescription>Description of test policy 1</PolicyDescription> <PolicyId>e1ee9345-b89f-462c-bcf0-713cf67fab8e</PolicyId> <PolicyName>Test Policy 1</PolicyName> <PolicyType>Advanced</PolicyType> </GetGSMSitePoliciesResponseModel_Policy> <GetGSMSitePoliciesResponseModel_Policy> <Canned>false</Canned> <DateCreated>2024-05-09T08:38:25.3384048Z</DateCreated> <DefaultSetting>false</DefaultSetting> <Deleted>false</Deleted> <GlobalPolicy>false</GlobalPolicy> <LivePolicy>true</LivePolicy> <PendingPolicy>false</PendingPolicy> <PolicyDescription>Description of test policy 2</PolicyDescription> <PolicyId>bb28c794-3507-4324-ae4c-9949047a9025</PolicyId> <PolicyName>Test Policy 2</PolicyName> <PolicyType>Advanced</PolicyType> </GetGSMSitePoliciesResponseModel_Policy> </Policies> <TotalCount>2</TotalCount> </GetGSMSitePoliciesResponseModel>