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/E1A1-DBF3-73D7-4A5F-BD24/sites/79375e7e-00b8-4bbb-bb31-b77b2336e78d/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": 5,
      "GroupCode": "-129966217",
      "GroupId": "be275eaf-8710-48b4-ad27-456cd0df68ec",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "6b2c2877-6393-4d8e-a47a-00336d72bf0a",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 86,
      "GroupCode": "-709184867",
      "GroupId": "73a98ce7-55a6-4d6f-a7f8-ea9f827a4376",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "9e3eada5-e821-492c-9ccb-b0aa2615771d",
      "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>5</Endpoints>
      <GroupCode>-129966217</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>be275eaf-8710-48b4-ad27-456cd0df68ec</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>6b2c2877-6393-4d8e-a47a-00336d72bf0a</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>86</Endpoints>
      <GroupCode>-709184867</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>73a98ce7-55a6-4d6f-a7f8-ea9f827a4376</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>9e3eada5-e821-492c-9ccb-b0aa2615771d</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>