Create a Group

Request Parameters

Parameter	Description	Note
description	Group description	Required: no
id	Group ID	Required: no. If the ID is not specified, it will be generated automatically. Valid values: digits, Latin characters, and symbols ‘_’, ‘-’, ‘.’
name	Group name	Required: yes
parent-group	Parent group ID	Required: no—with full administrator rights, yes—with group administrator rights
component-scanner	Individual components. Available values: 0—component must not be installed. 1—component can be installed, 2—component must be installed. If the components parameter is specified in a request, the parameter is to be used.	no
component-office-control
component-spider-guard
component-spider-guard-servers
component-spider-mail
component-spider-gate
component-msoutlook-plugin
component-firewall
component-antispam
components	Set of components that will be available on a client computer. Available values: bit field (see Appendix B2. Component Codes). If parameter is set, you do not need to set parameters for individual components installation.	no

The parent-group parameter is mandatory when creating a group on behalf of a user with group administrator rights.

Request Example

https://192.168.1.1:9081/api/groups/add.ds?id=1001&name=group4&parent-group=1&description=new

XML and JSON response structure examples are described below.

XML Response Structure

<drweb-es-api api_version="4.3.2" timestamp="1587993055" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<group id="1001"/>
</drweb-es-api>

Description of XML Response Parameters

The <group /> element contains a newly created group ID.

The <group /> element attribute:

Attribute	Description
id	Group ID

JSON Response Structure

{ "head": {
"status": true,

"timestamp": 1587993557,

"api": {
"version": 40302,
"versionString": "4.3.2"},

"server": {
"name": "192.168.1.1",

"version": "13.00.1.202310121",
"uuid": "25cf53c0-885a-11ea-5c35-289def4dadcb"}},

"data": {
"id": "1001"}}

Description of JSON Response Parameters

The data block contains a newly created group ID.

The data block element:

Field name	Description
id	Group ID