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/7778-E252-F14C-473D-8555/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": "499e18f5-6245-4797-8052-45920b6b9e33",
      "DateCreated": "2024-11-17T14:54:23.3715068Z",
      "PolicyName": "Test Policy 1",
      "LivePolicy": true,
      "PendingPolicy": false,
      "PolicyDescription": "Description of test policy 1",
      "Deleted": false,
      "Canned": false,
      "DefaultSetting": false,
      "PolicyType": "Advanced"
    },
    {
      "PolicyId": "b66375af-6310-426f-8d3c-0d59d8072439",
      "DateCreated": "2024-09-17T14:54:23.3715068Z",
      "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>2024-11-17T14:54:23.3715068Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>499e18f5-6245-4797-8052-45920b6b9e33</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMPoliciesResponseModel_Policy>
    <GetGSMPoliciesResponseModel_Policy>
      <Canned>false</Canned>
      <DateCreated>2024-09-17T14:54:23.3715068Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 2</PolicyDescription>
      <PolicyId>b66375af-6310-426f-8d3c-0d59d8072439</PolicyId>
      <PolicyName>Test Policy 2</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMPoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>2</TotalCount>
</GetGSMPoliciesResponseModel>