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/F099-750A-3EB4-4B07-8486/sites/3f42a694-4e2c-4ef5-bc30-afffca8837a7/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": 11,
      "GroupCode": "-754396694",
      "GroupId": "42e7a47d-536d-4218-9729-a175c57fe2db",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "7342c256-75f1-4769-a91c-aa026bb63237",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 71,
      "GroupCode": "-959702174",
      "GroupId": "dcafb54c-668e-4b72-91cb-10759b2b9d80",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "5a7a1e02-5401-4b44-aed0-3ece080b9d7a",
      "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>11</Endpoints>
      <GroupCode>-754396694</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>42e7a47d-536d-4218-9729-a175c57fe2db</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>7342c256-75f1-4769-a91c-aa026bb63237</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>71</Endpoints>
      <GroupCode>-959702174</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>dcafb54c-668e-4b72-91cb-10759b2b9d80</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>5a7a1e02-5401-4b44-aed0-3ece080b9d7a</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>