POST /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups
Creates a group under 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)
POST
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3B6F-1D29-AF5D-44BA-A1F7/sites/7500e7aa-3f83-4471-9aa2-90c0053c165f/groups
|
Body Parameters
Additional information for creating a new group.
CreateGroupRequestModelName | Description | Type | Additional Information |
---|---|---|---|
GroupName |
The name of the group. Maximum of 50 characters is allowed. |
string |
Required |
GroupDescription |
The description of the group. Maximum of 50 characters is allowed. |
string |
Required |
PolicyId |
The id of the policy applied to the group. If not specified, the default policy will be applied. |
string |
None. |
Sample Request
{ "GroupName": "Test Group", "GroupDescription": "Description of test group", "PolicyId": "fe0097e2-ef02-44d7-aef5-0b318a370a0d" }
<CreateGroupRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <GroupDescription>Description of test group</GroupDescription> <GroupName>Test Group</GroupName> <PolicyId>fe0097e2-ef02-44d7-aef5-0b318a370a0d</PolicyId> </CreateGroupRequestModel>
Response Information
Resource Description
Information about the created group.
CreateGroupResponseModelName | Description | Type | Additional Information |
---|---|---|---|
GroupId |
The id of the group that has been created. |
string |
None. |
Sample Response
{ "GroupId": "28b81df9-7665-4aad-8ff9-e1c78c79705b" }
<CreateGroupResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <GroupId>28b81df9-7665-4aad-8ff9-e1c78c79705b</GroupId> </CreateGroupResponseModel>