HomeGuidesAPI Reference
API Reference

Create or update a template group

Creates a new template group from an existing one or updates an existing template group's configuration. When the request body 'name' matches the 'templateGroup' query parameter, the endpoint updates the existing group. When they differ, a new template group is created using templates from the source group. QoS templates require a valid license.

Deployment behavior: There is no separate deploy/apply endpoint. Modifying a template group here or changing selections via POST /template/templateSelection automatically queues all associated appliances for orchestration. To determine which appliances are affected, call GET /template/applianceAssociation (no nePk) and find appliances whose templateIds include the modified group name.

Monitoring orchestration completion: After a POST, poll GET /template/history?nePk=<id>&latestOnly=true for each affected appliance. When the response includes a history entry for the modified template name with appliedOn timestamp newer than your POST time and status of 'successful', orchestration is complete for that appliance. If no new entry appears within your timeout, the appliance may still be pending or unreachable.

User Management template: The 'users' template contains a map of local appliance user accounts keyed by username. Each user has fields: self, enable, gid, password, gms_marked. Passwords are redacted (empty string) on GET; supply the new password in valObject on POST. Use GET /userAccount?nePk=<id> to verify user changes were applied to an appliance.

Related endpoints: Associate groups with appliances via POST /template/applianceAssociation. Check which groups an appliance has via GET /template/applianceAssociation?nePk=<id>.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
length ≥ 1

Target template group name. Must not be empty. If this matches the 'name' in the request body, the group is updated; otherwise a new group is created.

Body Params

Template group configuration containing the source group name (for cloning) or target group name (for updating) and the templates to save.

Request body for creating or updating a template group. When 'name' matches the 'templateGroup' query parameter, the group is updated. When they differ, a new template group is created from the source.

string
required
length ≥ 1

Source template group name (for cloning) or target group name (for updating). Must match an existing template group.

string

Optional audit log comment. Recorded in the system action log with 'Audit Log Comment : ' prefix.

templates
array of objects
required

Array of templates to save. Each template contains configuration data that will be applied to the group.

templates*
Responses

401

Unauthorized - Authentication required.

403

Forbidden - User lacks READ_WRITE role permissions.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain