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/2B55-DBD0-1AC3-40F9-B228/sites/3c8843bd-7022-48a7-9eb6-4da344484f89/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": 41,
      "GroupCode": "-565987705",
      "GroupId": "ab05d795-0e5e-4823-acdb-23df16d99926",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "5b30b5ca-82b9-42c7-87ae-ab8cef12452d",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 20,
      "GroupCode": "-745760443",
      "GroupId": "cdb175c8-786c-485e-83c7-a8a09b685f1d",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "e5c6a1a8-a463-4cea-a566-86a6b0b4164d",
      "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>41</Endpoints>
      <GroupCode>-565987705</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>ab05d795-0e5e-4823-acdb-23df16d99926</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>5b30b5ca-82b9-42c7-87ae-ab8cef12452d</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>20</Endpoints>
      <GroupCode>-745760443</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>cdb175c8-786c-485e-83c7-a8a09b685f1d</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>e5c6a1a8-a463-4cea-a566-86a6b0b4164d</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>