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/8972-0F6A-5079-49ED-8BB1/sites/e760ddc7-2803-43c4-a4e8-1022a8bcfdbc/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": 74,
      "GroupCode": "-549712938",
      "GroupId": "fe5186f1-647b-4398-8c7c-421576971574",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "09e11e24-5e95-4122-b4bf-3412924be206",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 93,
      "GroupCode": "-531080487",
      "GroupId": "c2e6df70-da0f-4ef0-bed4-a5e6fd1676a7",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "a6414ecd-1b72-4546-be85-f18601c4ad27",
      "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>74</Endpoints>
      <GroupCode>-549712938</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>fe5186f1-647b-4398-8c7c-421576971574</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>09e11e24-5e95-4122-b4bf-3412924be206</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>93</Endpoints>
      <GroupCode>-531080487</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>c2e6df70-da0f-4ef0-bed4-a5e6fd1676a7</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>a6414ecd-1b72-4546-be85-f18601c4ad27</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>