GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups

Gets the list of groups on a given GSM site.

Request Information

URI Parameters

Name	Description	Type	Additional 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/E916-E89C-0D91-4E35-92E1/sites/c8558b0c-4cf0-4c4f-8b49-a7b30eaa5b3a/groups

Body Parameters

None.

Response Information

Resource Description

Information about the list of groups on a given GSM site.

GetGroupsResponseModel

Name	Description	Type	Additional 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": 96,
      "GroupCode": "-495604579",
      "GroupId": "d382059f-cbf1-4bfc-96e9-11a3b9503f48",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "beeedcd4-065c-4e92-8b50-6b1f8a53698b",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 35,
      "GroupCode": "-751492190",
      "GroupId": "b1412806-fc8b-4d13-a2cd-a7f045d0e434",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "c290db1b-bc45-4667-8d16-230bb1a8f663",
      "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>96</Endpoints>
      <GroupCode>-495604579</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>d382059f-cbf1-4bfc-96e9-11a3b9503f48</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>beeedcd4-065c-4e92-8b50-6b1f8a53698b</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>35</Endpoints>
      <GroupCode>-751492190</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>b1412806-fc8b-4d13-a2cd-a7f045d0e434</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>c290db1b-bc45-4667-8d16-230bb1a8f663</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>