HomeGuidesAPI Reference
API Reference

Save Roles Configuration

Saves the complete roles configuration, replacing existing roles. Default roles (ID 0: 'default' with GPID 0, ID 1: 'unknown' with GPID 65535) are automatically added. Maximum 255 roles allowed including defaults. Deleting roles (by omission) cascades to: port profiles, templates, overlays, security policies, loopback configurations, and SSE connector pools/interfaces. The operation is atomic and synchronized.

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

Complete map of roles to save. Omitted roles from previous configuration will be deleted with cascading effects. Role IDs 0 and 1 are reserved for defaults and will be auto-populated.

Input map of custom roles keyed by role ID (string). Role IDs must be >= 0. IDs 0 and 1 are reserved for defaults and will be auto-populated. Maximum 255 total roles including defaults.

Responses

401

Unauthorized - User not authenticated or session has expired. Re-authenticate to obtain a valid session.

403

Forbidden - User lacks READ_WRITE permission required for this operation.

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