Skip to main content
POST
cURL

Body

application/json
​
spoke_gw
string
required

Spoke gateway name.

​
transit_gw
string
required

Transit gateway name.

​
CID
string

The opaque session ID token. Required for 7.2 controllers only.

​
action
string

The API action to perform. Required for 7.2 controllers only.

​
disable_activemesh
boolean

Disable activemesh.

​
dst_wan_interfaces
string

Select Edge Transit WAN interface(s) to attach, comma separated.

​
edge_wan_interfaces
string

Select Edge Spoke WAN interface(s) to attach, comma separated.

​
enable_az_affinity
boolean

Prefer same-AZ nexthop for spoke->transit routing.

​
insane_mode
boolean

Enable HPE mode for peering with Edge.

​
jumbo_frame
boolean

Enable jumbo frame for over private peering with Edge.

​
no_max_performance
boolean

Support HPE spoke join HPE transit with single tunnel config.

​
over_private_network
boolean

The underlay connects over the private network for peering with Edge.

​
route_table_list
string

Comma-separated route table ids.

​
spoke_group_uuid
string

Spoke group uuid.

​
spoke_gw_logical_ifnames
string

Select list of Spoke Gateway logical interface(s) to attach.

​
transit_group_uuid
string

Transit group uuid.

​
transit_gw_logical_ifnames
string

Select list of Transit Gateway logical interface(s) to attach.

​
tunnel_count
string

Number of tunnels for HPE mode peering.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

​
errortype
string

Error type if the API failed.

​
reason
string

Failure reason if the API failed.

​
results

API response data

​
return
boolean

Whether the API returned successfully