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/6D5B-C23C-12A5-41B0-BD98/sites/fa95911a-ecde-4f1f-9c6c-b7f7a761b030/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": "dd45ef71-7d1e-48ed-ab9a-510115564cc2" }
<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>dd45ef71-7d1e-48ed-ab9a-510115564cc2</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": "4779cca3-79fe-4d8c-a42f-228c271d3ef7" }
<CreateGroupResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <GroupId>4779cca3-79fe-4d8c-a42f-228c271d3ef7</GroupId> </CreateGroupResponseModel>