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/B5CD-5A8B-A6AB-4ECA-A78C/sites/1ed6dd98-9336-48fd-b265-6d2a4b74e82e/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": "143f9b7a-20e1-4291-ad0a-aa28cc86842d" }
<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>143f9b7a-20e1-4291-ad0a-aa28cc86842d</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": "488b4ef9-2a28-42b4-8bdb-1619d40f2190" }
<CreateGroupResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <GroupId>488b4ef9-2a28-42b4-8bdb-1619d40f2190</GroupId> </CreateGroupResponseModel>