Skip to main content
GET
cURL

Query Parameters

src_group_uuid
string

Source gateway group uuid.

dst_group_uuid
string

Destination gateway group uuid.

over_aws_peering
enum<string>

Over native peering. A boolean choice expressed as a string

Available options:
yes,
no
src_filter_list
string

Source Site Filter CIDR List.

dst_filter_list
string

Destination Site Filter CIDR List.

src_exclude_conn
string

Source Site Exclude Connection List.

dst_exclude_conn
string

Destination Site Exclude Connection List.

private_ip_peering
string

Peering by gateway private ip.

single_tunnel
string

Peering in single tunnel, not HPE mode.

show
boolean

Show existing peering config info.

insane_mode_over_internet
boolean

Enable HPE mode over internet.

tunnel_count
string

Number of tunnels for HPE mode over internet.

no_max_performance
boolean

Support HPE transit peering over private network single tunnel config.

over_private_network
boolean

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

jumbo_frame
boolean

Enable jumbo frame for over private peering with Edge Transit.

insane_mode
boolean

Enable HPE mode for peering with Edge Transit.

src_wan_interfaces
string

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

dst_wan_interfaces
string

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

src_gw_logical_ifnames
string

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

dst_gw_logical_ifnames
string

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

disable_activemesh
boolean

Disable activemesh.

enable_firenet_for_edge
boolean

Enable Firenet for Edge.

enable_az_affinity
string

Prefer same-AZ nexthop for transit-transit routing.

enable_vrf_on_attachment
enum<string>

For update_vrf_on_attachment: yes or no. A boolean choice expressed as a string

Available options:
yes,
no
all
boolean

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

action
string

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

CID
string

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

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