Skip to main content
POST
cURL

Body

application/json
gateway1
string
required

Source gateway name.

gateway2
string
required

Destination 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.

all
boolean

For VRF attachment APIs: all eligible transit peerings (no pair).

destination_exclude_connections
string

Destination Site Exclude Connection List.

destination_filter_cidrs
string

Destination Site Filter CIDR List.

disable_activemesh
boolean

Disable activemesh.

dst_group_uuid
string

Destination gateway group uuid.

dst_gw_logical_ifnames
string

Select list of dst Edge Transit WAN interface(s) to attach.

dst_wan_interfaces
string

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

enable_az_affinity
string

Prefer same-AZ nexthop for transit-transit routing.

enable_firenet_for_edge
boolean

Enable Firenet for Edge.

enable_vrf_on_attachment
enum<string>

For update_vrf_on_attachment: yes or no.

Available options:
yes,
no
insane_mode
boolean

Enable HPE mode for peering with Edge Transit.

insane_mode_over_internet
boolean

Enable HPE mode over internet.

jumbo_frame
boolean

Enable jumbo frame for over private peering with Edge Transit.

no_max_performance
boolean

Support HPE transit peering over private network single tunnel config.

over_aws_peering
enum<string>

Over native peering.

Available options:
yes,
no
over_private_network
boolean

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

private_ip_peering
string

Peering by gateway private ip.

show
boolean

Show existing peering config info.

single_tunnel
string

Peering in single tunnel, not HPE mode.

source_exclude_connections
string

Source Site Exclude Connection List.

source_filter_cidrs
string

Source Site Filter CIDR List.

src_group_uuid
string

Source gateway group uuid.

src_gw_logical_ifnames
string

Select list of src Edge Transit WAN interface(s) to attach.

src_wan_interfaces
string

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

tunnel_count
string

Number of tunnels for HPE mode over internet.

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