Documentation

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

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

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/5C6E-9B44-EB40-422D-804C/policies

Body Parameters

None.

Response Information

Resource Description

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

GetGSMPoliciesResponseModel

Name	Description	Type	Additional 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": "16f5047b-76c5-4857-9fe4-8fb5809dd47c",
      "DateCreated": "2024-02-26T03:20:05.8771855Z",
      "PolicyName": "Test Policy 1",
      "LivePolicy": true,
      "PendingPolicy": false,
      "PolicyDescription": "Description of test policy 1",
      "Deleted": false,
      "Canned": false,
      "DefaultSetting": false,
      "PolicyType": "Advanced"
    },
    {
      "PolicyId": "07748686-c7cb-442e-8562-38623a5bd1af",
      "DateCreated": "2023-12-26T03:20:05.8771855Z",
      "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-02-26T03:20:05.8771855Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>16f5047b-76c5-4857-9fe4-8fb5809dd47c</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMPoliciesResponseModel_Policy>
    <GetGSMPoliciesResponseModel_Policy>
      <Canned>false</Canned>
      <DateCreated>2023-12-26T03:20:05.8771855Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 2</PolicyDescription>
      <PolicyId>07748686-c7cb-442e-8562-38623a5bd1af</PolicyId>
      <PolicyName>Test Policy 2</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMPoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>2</TotalCount>
</GetGSMPoliciesResponseModel>