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/B59B-5A7D-852C-460D-8CFB/sites/c09409a8-a32b-4571-b6a9-27a1924e81e6/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": 52,
      "GroupCode": "-897904321",
      "GroupId": "d6716216-8e11-4f8e-9935-8844d372e421",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "12904a10-874f-43f0-a4dc-a92a09ba7dc1",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 27,
      "GroupCode": "-214506780",
      "GroupId": "30d914fe-ec47-4177-8bbc-a94435c0a63a",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "8c1d363d-b86a-40a4-950f-f12b0e160585",
      "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>52</Endpoints>
      <GroupCode>-897904321</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>d6716216-8e11-4f8e-9935-8844d372e421</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>12904a10-874f-43f0-a4dc-a92a09ba7dc1</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>27</Endpoints>
      <GroupCode>-214506780</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>30d914fe-ec47-4177-8bbc-a94435c0a63a</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>8c1d363d-b86a-40a4-950f-f12b0e160585</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>