Unity API Documentation

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/ABC3-F74B-4002-45B4-B8F0/sites/a616bc4f-7858-458b-af3e-d7fcf0ab9a06/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": 81,
      "GroupCode": "-304556790",
      "GroupId": "a83d6815-6ab3-474a-bb88-e0236bdec9d3",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "266cd556-ba36-4ab7-8c46-b628b765cfe2",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 60,
      "GroupCode": "-500240923",
      "GroupId": "f351855f-eafd-40ff-99d0-235ff2fe28ea",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "3dcb9e6e-d837-4393-8ac8-65bdbfec3084",
      "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>81</Endpoints>
      <GroupCode>-304556790</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>a83d6815-6ab3-474a-bb88-e0236bdec9d3</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>266cd556-ba36-4ab7-8c46-b628b765cfe2</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>60</Endpoints>
      <GroupCode>-500240923</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>f351855f-eafd-40ff-99d0-235ff2fe28ea</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>3dcb9e6e-d837-4393-8ac8-65bdbfec3084</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>