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

Update an existing Edge HA group

put
http://127.0.0.1:8080/edge-ha/groups

Updates HA group settings such as subnet, mask, or VLAN configuration. Appliance membership cannot be modified; unpair and recreate the group to change appliances. Requires READ_WRITE role.

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

Unique identifier of the HA group to update. Must reference an existing group.

Body Params

Updated HA group configuration. Must include exactly 2 appliances with valid haSyncInfo. Appliance membership must match the existing group.

High Availability group configuration containing a pair of appliances with network settings for redundancy.

appliances
array of objects
required
length between 2 and 2

Array of exactly 2 appliances forming the HA pair. Both appliances must be in inline-router mode.

appliances*

Appliance configuration within an HA group.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

string
required

HA interface name used for cross-connection between HA pair appliances.

haSyncInfo
object
required

HA synchronization configuration. Required when saving - cannot be null.

Appliance configuration within an HA group.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

string
required

HA interface name used for cross-connection between HA pair appliances.

haSyncInfo
object
required

HA synchronization configuration. Required when saving - cannot be null.

string
required
Defaults to 169.254.1.0/24

IPv4 subnet for allocating IPs to internal HA VLAN interfaces. Must provide minimum 32 subnets based on mask.

integer
required
0 to 32
Defaults to 30

Subnet mask for carving IP blocks from the HA subnet. Used to create smaller subnets for each HA interface.

integer
required
1 to 4094
Defaults to 100

Starting VLAN ID for internal HA VLAN interfaces. Increments by 1 for each additional VLAN interface.

string

IPv6 subnet for HA interfaces. Used when appliances have IPv6 WAN interfaces (requires appliance version 9.6.0+).

integer
0 to 128

IPv6 subnet mask for HA interfaces. Used when v6HaSubnet is configured.

Responses
204

HA group updated successfully. No content returned.

401

Unauthorized. User authentication failed or user lacks READ_WRITE role permission.

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

Did this page help you?