Unity API Documentation

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

Gets information about a site policy.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

 string

Required
siteId

The site identifier.

 string

Required
policyId

The identifier of the policy to query information for.

 string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/3F33-A791-C0DB-4ACD-AB3F/sites/749e5bd8-602c-45d9-8669-fd86b27e246d/policies/a529f384-2e80-45ef-b975-cf2fc3a512a0

Body Parameters

None.

Response Information

Resource Description

Information about the desired site policy.

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": 1,
  "Deleted": false,
  "Policies": [
    {
      "PolicyId": "a87f9ea0-71f2-43b2-94d0-b599647de16a",
      "DateCreated": "2024-07-09T08:01:24.3174566Z",
      "PolicyName": "Test Policy 1",
      "LivePolicy": true,
      "PendingPolicy": false,
      "PolicyDescription": "Description of test policy 1",
      "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>2024-07-09T08:01:24.3174566Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <GlobalPolicy>false</GlobalPolicy>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>a87f9ea0-71f2-43b2-94d0-b599647de16a</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMSitePoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>1</TotalCount>
</GetGSMSitePoliciesResponseModel>