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/F115-BF92-2B22-49A2-9DF3/sites/3b3ba785-ddf5-409d-b6ee-636e9dd5b41b/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": 14,
      "GroupCode": "-935669657",
      "GroupId": "f3ca67b4-25f7-4438-9789-6c0c762a02db",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "834201d4-164b-4cd8-9d38-42b36f03b8f8",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 88,
      "GroupCode": "-552633358",
      "GroupId": "186ef95b-66f9-43ed-9bb0-03e2b9a23c74",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "c26cbf9d-5581-414a-b73a-21c4fa83aa01",
      "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>14</Endpoints>
      <GroupCode>-935669657</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>f3ca67b4-25f7-4438-9789-6c0c762a02db</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>834201d4-164b-4cd8-9d38-42b36f03b8f8</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>88</Endpoints>
      <GroupCode>-552633358</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>186ef95b-66f9-43ed-9bb0-03e2b9a23c74</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>c26cbf9d-5581-414a-b73a-21c4fa83aa01</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>