HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. group

Create a new user-defined group

post
http://127.0.0.1:8080/gms/group/new

Creates a new user-defined group in the Orchestrator hierarchy. Requires READ_WRITE role. The group name must be unique across all groups. If parentId is omitted, the group is created under the root group (0.Network). Groups cannot be created under the auto-discovered group (2.Network).

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

Group configuration object containing the name, parent group ID, and optional background image

Request body for creating a new group in the Orchestrator hierarchy

string
required
length ≥ 1

Unique display name for the group. Must be non-empty and unique across all groups.

string
^[0-9]+\.Network$
Defaults to 0.Network

Primary key of the parent group in format '{number}.Network'. Defaults to '0.Network' (root group) if omitted. Cannot be '2.Network' (auto-discovered group).

string
Defaults to data_net.png

Filename of the background image/icon for the group. Defaults to 'data_net.png' if omitted.

Responses
204

Group created successfully. No content returned.

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ_WRITE permission

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 11 hours ago

Did this page help you?