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/CD83-DE92-3E8F-486E-AFF9/sites/0b14db23-a4a0-4aa9-901b-94dc2da0ea3a/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": 50,
      "GroupCode": "-309712200",
      "GroupId": "190c2833-a097-4c81-9c5f-4200dcfec472",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "da173582-ae36-4cb3-a899-0b1c8892d09c",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 78,
      "GroupCode": "-330535888",
      "GroupId": "fb122329-947b-4dd1-bdbf-574ce4081505",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "4d84296e-97ba-463b-8851-a8dc43c8e743",
      "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>50</Endpoints>
      <GroupCode>-309712200</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>190c2833-a097-4c81-9c5f-4200dcfec472</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>da173582-ae36-4cb3-a899-0b1c8892d09c</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>78</Endpoints>
      <GroupCode>-330535888</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>fb122329-947b-4dd1-bdbf-574ce4081505</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>4d84296e-97ba-463b-8851-a8dc43c8e743</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>