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/20E1-0835-FEA7-45DE-B59B/sites/0d5de330-9ec0-4fbd-9ac5-d5fe6a71702a/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": 5,
      "GroupCode": "-562757322",
      "GroupId": "96816cb1-8ef1-478f-b14a-e255a6bb0309",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "aa3cef75-48a1-49ef-a6ec-4edc8bb1212e",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 95,
      "GroupCode": "-791865785",
      "GroupId": "6458ebca-b01a-4837-812f-0710ae58ea8c",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "af75f40b-a68f-4069-8a08-e62be31451c0",
      "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>5</Endpoints>
      <GroupCode>-562757322</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>96816cb1-8ef1-478f-b14a-e255a6bb0309</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>aa3cef75-48a1-49ef-a6ec-4edc8bb1212e</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>95</Endpoints>
      <GroupCode>-791865785</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>6458ebca-b01a-4837-812f-0710ae58ea8c</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>af75f40b-a68f-4069-8a08-e62be31451c0</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>