Documentation

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/DC1B-CA85-1BFC-46E5-A9DD/sites/ed275d1c-8cdd-46d3-9960-327a7078d5e4/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": "5bbc5381-d3bf-4785-84ae-ff1e89dfca75",
      "DateCreated": "2022-12-09T06:19:03.4530921Z",
      "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": "fc02c992-56d0-43ea-bdcd-3866d1c67e72",
      "DateCreated": "2022-10-09T06:19:03.4530921Z",
      "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>2022-12-09T06:19:03.4530921Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <GlobalPolicy>false</GlobalPolicy>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>5bbc5381-d3bf-4785-84ae-ff1e89dfca75</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMSitePoliciesResponseModel_Policy>
    <GetGSMSitePoliciesResponseModel_Policy>
      <Canned>false</Canned>
      <DateCreated>2022-10-09T06:19:03.4530921Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <GlobalPolicy>false</GlobalPolicy>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 2</PolicyDescription>
      <PolicyId>fc02c992-56d0-43ea-bdcd-3866d1c67e72</PolicyId>
      <PolicyName>Test Policy 2</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMSitePoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>2</TotalCount>
</GetGSMSitePoliciesResponseModel>