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/A265-B006-C141-4426-A0BD/sites/5e9eed13-2ff1-4b73-9561-cdb4112cb4d4/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": 14,
      "GroupCode": "-277942863",
      "GroupId": "1f499452-5534-4395-bc8b-7201e506c494",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "47435496-ddfc-405d-a732-b351e7ea7c59",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 34,
      "GroupCode": "-465101146",
      "GroupId": "6eec6290-422a-4788-8ca8-fb5d53a58fd2",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "766bdf6f-5ddc-4b11-ac7d-33f6fa9db5c8",
      "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>14</Endpoints>
      <GroupCode>-277942863</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>1f499452-5534-4395-bc8b-7201e506c494</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>47435496-ddfc-405d-a732-b351e7ea7c59</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>34</Endpoints>
      <GroupCode>-465101146</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>6eec6290-422a-4788-8ca8-fb5d53a58fd2</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>766bdf6f-5ddc-4b11-ac7d-33f6fa9db5c8</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>