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/8909-6F7D-B2DB-4BCC-A155/sites/a888fe80-d778-4e8b-a7b0-e3ad6f89ce3e/groups
|
Body Parameters
Additional information for creating a new group.
CreateGroupRequestModel| Name | 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": "33b84993-1bef-48de-8fde-74b04694ebeb"
}
<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>33b84993-1bef-48de-8fde-74b04694ebeb</PolicyId> </CreateGroupRequestModel>
Response Information
Resource Description
Information about the created group.
CreateGroupResponseModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| GroupId |
The id of the group that has been created. |
string |
None. |
Sample Response
{
"GroupId": "9dc4c1c7-619f-4c93-b843-2b7685dabfb6"
}
<CreateGroupResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <GroupId>9dc4c1c7-619f-4c93-b843-2b7685dabfb6</GroupId> </CreateGroupResponseModel>