Unity API Documentation

GET /service/api/console/gsm/{gsmKey}/policies

Gets the list of global policies on a given GSM console.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

 string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/6494-21D0-F878-4314-B4CC/policies

Body Parameters

None.

Response Information

Resource Description

Information about the list of global policies on a given GSM console.

GetGSMPoliciesResponseModel
NameDescriptionTypeAdditional Information
TotalCount

Total number of policies available.

 integer

None.
Deleted

Value (true/false) indicating if any of the policies are deleted.

 boolean

None.
Policies

List of policy details records.

 Collection of GetGSMPoliciesResponseModel_Policy

None.

Sample Response

{
  "TotalCount": 2,
  "Deleted": false,
  "Policies": [
    {
      "PolicyId": "31b67480-1fdc-4c1e-b524-1e62c413a3d5",
      "DateCreated": "2020-05-12T20:08:37.8848047Z",
      "PolicyName": "Test Policy 1",
      "LivePolicy": true,
      "PendingPolicy": false,
      "PolicyDescription": "Description of test policy 1",
      "Deleted": false,
      "Canned": false,
      "DefaultSetting": false,
      "PolicyType": "Advanced"
    },
    {
      "PolicyId": "2ebe6f66-4187-47e6-bac1-8e7de2301581",
      "DateCreated": "2020-03-12T20:08:37.8848047Z",
      "PolicyName": "Test Policy 2",
      "LivePolicy": true,
      "PendingPolicy": false,
      "PolicyDescription": "Description of test policy 2",
      "Deleted": false,
      "Canned": false,
      "DefaultSetting": false,
      "PolicyType": "Advanced"
    }
  ]
}                    
<GetGSMPoliciesResponseModel 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>
    <GetGSMPoliciesResponseModel_Policy>
      <Canned>false</Canned>
      <DateCreated>2020-05-12T20:08:37.8848047Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>31b67480-1fdc-4c1e-b524-1e62c413a3d5</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMPoliciesResponseModel_Policy>
    <GetGSMPoliciesResponseModel_Policy>
      <Canned>false</Canned>
      <DateCreated>2020-03-12T20:08:37.8848047Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 2</PolicyDescription>
      <PolicyId>2ebe6f66-4187-47e6-bac1-8e7de2301581</PolicyId>
      <PolicyName>Test Policy 2</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMPoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>2</TotalCount>
</GetGSMPoliciesResponseModel>