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/28DF-E641-D4C3-462B-AE12/sites/4db8f0fb-b8a6-486d-aada-f40a0c1485c5/groups
|
Body Parameters
None.
Response Information
Resource Description
Information about the list of groups on a given GSM site.
GetGroupsResponseModelName | 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": 66, "GroupCode": "-532641554", "GroupId": "e9d475a9-ca68-4626-9ac7-74cbec00b262", "GroupName": "Test Group 1", "GroupDescription": "Description of test group 1", "GroupPolicyId": "591f0871-36c7-416a-a4bb-98eff9154a64", "GroupPolicyName": "Test Policy 1" }, { "Endpoints": 78, "GroupCode": "-774022231", "GroupId": "1ebde439-902e-45e6-a8d5-2304da09160c", "GroupName": "Test Group 2", "GroupDescription": "Description of test group 2", "GroupPolicyId": "87d808db-4f1a-4045-9356-bb0d9f668f68", "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>66</Endpoints> <GroupCode>-532641554</GroupCode> <GroupDescription>Description of test group 1</GroupDescription> <GroupId>e9d475a9-ca68-4626-9ac7-74cbec00b262</GroupId> <GroupName>Test Group 1</GroupName> <GroupPolicyId>591f0871-36c7-416a-a4bb-98eff9154a64</GroupPolicyId> <GroupPolicyName>Test Policy 1</GroupPolicyName> </GetGroupsResponseModel_Group> <GetGroupsResponseModel_Group> <Endpoints>78</Endpoints> <GroupCode>-774022231</GroupCode> <GroupDescription>Description of test group 2</GroupDescription> <GroupId>1ebde439-902e-45e6-a8d5-2304da09160c</GroupId> <GroupName>Test Group 2</GroupName> <GroupPolicyId>87d808db-4f1a-4045-9356-bb0d9f668f68</GroupPolicyId> <GroupPolicyName>Test Policy 2</GroupPolicyName> </GetGroupsResponseModel_Group> </Groups> <TotalCount>2</TotalCount> </GetGroupsResponseModel>