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

Update Cluster Profile

put
http://127.0.0.1:8080/cluster/profiles

Updates an existing cluster profile configuration. The profile ID must match an existing profile. Automatically marks all mapped sites for cluster update and queues all appliances for applying the updated profile.

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

Complete cluster profile object with updated values. The 'id' field must match an existing profile.

Cluster profile configuration for updating existing profiles. The 'id' must match an existing profile. EdgeHA profiles have special restrictions.

uuid
required

System-generated unique identifier. Must match an existing profile ID.

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: mgmt1, wan0-15, lan0-15, tlan0-2, blan0-2, slan0-2, or custom LAN-side labels. Must be null for EdgeHA profiles.

string
enum
required

Flow redirection mode. 'Secure' uses encryption, 'ClearText' uses no encryption, 'Disabled' turns off flow redirection. Must be 'Disabled' for EdgeHA profiles.

Allowed:
string
enum
required

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

Allowed:
integer
required
0 to 500

Wait time in seconds (0-500) before flow redirection. Must be 0 when flowRedirection is 'Disabled' or for EdgeHA profiles.

boolean
required

Read-only flag indicating if this is an EdgeHA profile. Cannot be modified from original value.

Responses

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ_WRITE role.

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?