HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Create new group.

Create new group given a group name and configuration
mode(UI or template mode of configuration) to be set per device type.

The password provided would not be saved.
Please use respective device configuration UI feature page or api's (if exists) to set the device admin password at group level

Configuration mode can be set for Access points and Gateways under the 'Wireless' field and for
switches under the 'Wired' field. The configuration mode is specified as a boolean value indicating
if the device type is managed using the template mode of configuration or not.

Groups can now be created with certain properties like the device types to be allowed in the group,
persona for device types in the group, monitor only mode for switches, etc.

The groups created with this api will have default properties set.

To create groups with specific properties, please use configuration/v3/groups api.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Group Name.

string
length between 1 and 128

Group Name

group_attributes
object
Responses
201

Created.

401

Unauthorized access, authentication required.

403

Forbidden, do not have write access for group.

413

Request-size limit exceeded.

417

Request-size limit exceeded.

429

API Rate limit exceeded.

default

the default response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json