Unity API Documentation

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

Gets the list of groups 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/A1D0-E1CB-24A0-491D-B26D/sites/aaaae483-26e9-4f96-8d22-093d0112260f/groups

Body Parameters

None.

Response Information

Resource Description

Information about the list of groups on a given GSM site.

GetGroupsResponseModel
NameDescriptionTypeAdditional Information
TotalCount

Total number of groups available.

 integer

None.
Groups

List of group details records.

 Collection of GetGroupsResponseModel_Group

None.

Sample Response

{
  "TotalCount": 2,
  "Groups": [
    {
      "Endpoints": 33,
      "GroupCode": "-413031330",
      "GroupId": "c481d375-a3c4-4366-9162-466e3aeb7483",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "b7e39ade-8bf2-4bd8-b30c-18b8af9fd1dc",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 29,
      "GroupCode": "-967318471",
      "GroupId": "ed903cdc-a385-4b99-a331-838fef049ba9",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "978cf17c-4f83-47fe-ac74-0889ab22cf3a",
      "GroupPolicyName": "Test Policy 2"
    }
  ]
}                    
<GetGroupsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Groups>
    <GetGroupsResponseModel_Group>
      <Endpoints>33</Endpoints>
      <GroupCode>-413031330</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>c481d375-a3c4-4366-9162-466e3aeb7483</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>b7e39ade-8bf2-4bd8-b30c-18b8af9fd1dc</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>29</Endpoints>
      <GroupCode>-967318471</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>ed903cdc-a385-4b99-a331-838fef049ba9</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>978cf17c-4f83-47fe-ac74-0889ab22cf3a</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>