Documentation

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

Gets information about a GSM policy.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	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/E8FD-C194-0876-4EB1-A586/policies/01ff4502-b350-4615-a4e1-13cbdc4e72c8

Body Parameters

None.

Response Information

Resource Description

Information about the desired GSM policy.

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": 1,
  "Deleted": false,
  "Policies": [
    {
      "PolicyId": "f1d322d8-e509-46bb-b39c-c4024e3445ff",
      "DateCreated": "2022-12-09T05:28:51.8005931Z",
      "PolicyName": "Test Policy 1",
      "LivePolicy": true,
      "PendingPolicy": false,
      "PolicyDescription": "Description of test policy 1",
      "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>2022-12-09T05:28:51.8005931Z</DateCreated>
      <DefaultSetting>false</DefaultSetting>
      <Deleted>false</Deleted>
      <LivePolicy>true</LivePolicy>
      <PendingPolicy>false</PendingPolicy>
      <PolicyDescription>Description of test policy 1</PolicyDescription>
      <PolicyId>f1d322d8-e509-46bb-b39c-c4024e3445ff</PolicyId>
      <PolicyName>Test Policy 1</PolicyName>
      <PolicyType>Advanced</PolicyType>
    </GetGSMPoliciesResponseModel_Policy>
  </Policies>
  <TotalCount>1</TotalCount>
</GetGSMPoliciesResponseModel>