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

Gets the list of policies on a given GSM site.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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/BBD1-5449-D5B0-4245-BACC/sites/7e34fcf9-a539-4ba9-b447-459a038ad6e5/policies

Body Parameters

None.

Response Information

Resource Description

Information about the list of policies available on a given GSM site.

GetGSMSitePoliciesResponseModel
NameDescriptionTypeAdditional 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": "12df4daa-cc5d-4254-8ed5-c64e928ad27d",
      "DateCreated": "2023-12-29T08:48:55.8252142Z",
      "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": "e448d90c-1a0a-4510-b363-4d025fc1e8f3",
      "DateCreated": "2023-10-29T08:48:55.8252142Z",
      "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>2023-12-29T08:48:55.8252142Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <GlobalPolicy>false</GlobalPolicy>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>12df4daa-cc5d-4254-8ed5-c64e928ad27d</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMSitePoliciesResponseModel_Policy>
    <GetGSMSitePoliciesResponseModel_Policy>
      <Canned>false</Canned>
      <DateCreated>2023-10-29T08:48:55.8252142Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <GlobalPolicy>false</GlobalPolicy>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 2</PolicyDescription>
      <PolicyId>e448d90c-1a0a-4510-b363-4d025fc1e8f3</PolicyId>
      <PolicyName>Test Policy 2</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMSitePoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>2</TotalCount>
</GetGSMSitePoliciesResponseModel>