HomeGuidesAPI Reference
API Reference

Add Cluster Profiles

Creates one or more new cluster profiles for flow redirection and user session synchronization between appliances. Profile IDs are auto-generated UUIDs and names must be unique across all profiles.

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

Array of cluster profile configurations to create. Do not include 'id' or 'isEdgeHaProfile' fields as they are system-managed.

Cluster profile configuration for creating new profiles. Used to define flow redirection and user session sync settings between appliances.

string
required
^[-_A-Za-z0-9]+$

Unique name for the cluster profile. Must contain only alphanumeric characters, dashes, and underscores.

string
required

Interface label for cluster communication. Valid values: mgmt1, wan0-wan15, lan0-lan15, tlan0-tlan2, blan0-blan2, slan0-slan2, or custom LAN-side labels.

string
enum
required

Flow redirection mode between cluster peers. 'Secure' uses encryption, 'ClearText' uses no encryption, 'Disabled' turns off flow redirection.

Allowed:
string
enum
required

User session synchronization mode between cluster peers. 'Secure' uses encryption, 'ClearText' uses no encryption, 'Disabled' turns off sync.

Allowed:
integer
required
0 to 500

Wait time in seconds before flow redirection occurs. Must be 0-500. Only effective when flowRedirection is not 'Disabled'. Set to 0 when flowRedirection is 'Disabled'.

Responses

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ_WRITE role.

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