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/297F-A844-3E94-4252-9C7B/policies/01ef80a1-4209-4514-ba3f-f90c77c1c823
|
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": "d5613323-a044-4004-ae40-2a8551cd8cfb",
"DateCreated": "2025-11-29T07:41:39.403Z",
"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>2025-11-29T07:41:39.403Z</DateCreated>
<DefaultSetting>false</DefaultSetting>
<Deleted>false</Deleted>
<LivePolicy>true</LivePolicy>
<PendingPolicy>false</PendingPolicy>
<PolicyDescription>Description of test policy 1</PolicyDescription>
<PolicyId>d5613323-a044-4004-ae40-2a8551cd8cfb</PolicyId>
<PolicyName>Test Policy 1</PolicyName>
<PolicyType>Advanced</PolicyType>
</GetGSMPoliciesResponseModel_Policy>
</Policies>
<TotalCount>1</TotalCount>
</GetGSMPoliciesResponseModel>