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

Update a user-defined group

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

Updates an existing user-defined group's name and/or background image. System groups (0.Network=Root, 1.Network=Internal, 2.Network=Auto-discovered) cannot be updated. The group name must be unique across all groups. The group ID is set from the query parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^[0-9]+\.Network$

Unique identifier of the group to update in format '{number}.Network'. Only user-defined groups (3.Network onwards) can be updated.

Body Params

Group update object containing the ID, new name, and optional background image. The ID in the body must match the query parameter.

Request body for updating an existing user-defined group

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

Primary key of the group to update in format '{number}.Network'. Only user-defined groups (id >= 3.Network) can be updated.

string
required
length ≥ 1

New unique display name for the group. Must be non-empty.

string

Optional new background image/icon filename for the group.

Responses
204

Group updated successfully. No content returned.

401

Unauthorized - Authentication required or session expired

403

Forbidden - User lacks READ_WRITE permission

409

Conflict - A group with the specified name already exists

Updated about 12 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 12 hours ago

Did this page help you?