Create a new Edge HA group

post

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

Creates a new high availability pairing between exactly two appliances. Each appliance can only belong to one HA group at a time. The system validates that neither appliance exists in another group before creation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

HA group configuration containing exactly two appliances to pair for high availability failover.

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.

nePk

string

required

^\d+\.NE$

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

haIf

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.

nePk

string

required

^\d+\.NE$

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

haIf

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.

subnet

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.

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.

vlanStart

integer

required

1 to 4094

Defaults to 100

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

v6HaSubnet

string

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

v6HaMask

integer

0 to 128

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

Responses

204

HA group created successfully. No content returned. Both appliances are now paired for high availability failover.

401

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

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad request due to validation failure.

500Internal server error. Failed to create HA group due to system error or communication failure with appliances.