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/E93F-C22A-DF9D-49B4-AE7E/sites/ae81a181-cf31-4487-9d34-f50d83521e45/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": 90,
      "GroupCode": "-762470283",
      "GroupId": "a90cb8bb-c684-4f2c-9d60-7fa3ccac2883",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "2d132c00-ed80-4b70-9dee-16269a10db73",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 28,
      "GroupCode": "-322236232",
      "GroupId": "8a7f8895-3dcc-4752-9035-dabdb25f7595",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "d38d1edb-59d5-41c7-8835-fcbe6041a841",
      "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>90</Endpoints>
      <GroupCode>-762470283</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>a90cb8bb-c684-4f2c-9d60-7fa3ccac2883</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>2d132c00-ed80-4b70-9dee-16269a10db73</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>28</Endpoints>
      <GroupCode>-322236232</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>8a7f8895-3dcc-4752-9035-dabdb25f7595</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>d38d1edb-59d5-41c7-8835-fcbe6041a841</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>