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/6AD0-3B85-2027-475F-B01D/sites/a372acea-56ac-4d6e-979c-706134007c11/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": 58,
      "GroupCode": "-949788168",
      "GroupId": "98072931-c274-4158-8dde-3eba1b994b81",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "ff3c6afd-2fe5-4ced-9017-a17df0b3900d",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 89,
      "GroupCode": "-831602005",
      "GroupId": "ead30b8f-e52e-4f58-a6f9-270b163bb909",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "b7443ed9-a398-4e0e-af55-e9ef274ba524",
      "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>58</Endpoints>
      <GroupCode>-949788168</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>98072931-c274-4158-8dde-3eba1b994b81</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>ff3c6afd-2fe5-4ced-9017-a17df0b3900d</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>89</Endpoints>
      <GroupCode>-831602005</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>ead30b8f-e52e-4f58-a6f9-270b163bb909</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>b7443ed9-a398-4e0e-af55-e9ef274ba524</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>