Skip to main content
GET
cURL

Query Parameters

​
gateway_name
string
required

Gateway name.

​
show
boolean

Show gateway info.

​
connected_transit
enum<string>

Connected transit to build a full mesh spoke networks.

Available options:
no,
yes
​
advertise_transit_cidr
enum<string>

Advertise Transit CIDR.

Available options:
no,
yes
​
bgp_manual_spoke_advertise_cidrs
string

BGP Manual Spoke Advertise CIDRs.

​
bgp_manual_spoke_advertise_cidrs_csv_file
string

BGP Manual Spoke Advertise CIDRs csv file.

​
conn_bgp_manual_advertise_cidrs
string

Connection BGP Manual Advertise CIDRs.

​
conn_bgp_manual_advertise_cidrs_csv_file
string

Connection BGP Manual Advertise CIDRs csv file.

​
bgp_prepend_as_path
string

Gateway based BGP Prepend AS Path.

​
learned_cidrs_approval
enum<string>

Learned cidrs approval (deprecated).

Available options:
no,
yes
​
enable_gw_cidr_approval
enum<string>

Enable / Disable route approval at gateway level.

Available options:
no,
yes
​
pending_learned_cidrs
string

Pending learned CIDRs.

​
approved_learned_cidrs
string

Approved learned CIDRs.

​
pending_learned_cidrs_csv_file
string

Pending learned CIDRs csv file.

​
approved_learned_cidrs_csv_file
string

Approved learned CIDRs csv file.

​
gw_approved_cidr_rules
string

GW Approved CIDR rules.

​
conn_learned_cidrs_approval
enum<string>

Connection Learned cidrs approval (deprecated).

Available options:
no,
yes
​
enable_conn_cidr_approval
enum<string>

Connection Learned cidrs approval.

Available options:
no,
yes
​
conn_pending_learned_cidrs
string

Connection Pending learned CIDRs.

​
conn_approved_learned_cidrs
string

Connection Approved learned CIDRs.

​
conn_pending_learned_cidrs_csv_file
string

Connection Pending learned CIDRs csv file.

​
conn_approved_learned_cidrs_csv_file
string

Connection Approved learned CIDRs csv file.

​
conn_approved_cidr_rules
string

Connection Approved CIDR rules.

​
learned_cidrs_approval_mode
enum<string>

Learned cidrs approval mode (deprecated).

Available options:
connection,
gateway
​
cidr_approval_mode
enum<string>

Cidr approval mode.

Available options:
connection,
gateway
​
show_cidrs_approval_info
boolean

Show gateway learned cidrs info (deprecated).

​
show_cidr_approval_info
boolean

Show gateway cidr approval info.

​
edit_conn_bgp_bfd
boolean

Edit connection BFD parameters.

​
edit_bgp_multihop
boolean

Edit connection BGP multihop.

​
bgp_multihop
boolean

Connection multihop value.

​
local_asn_num
string

Local ASN Number.

​
bgp_ecmp
enum<string>

Enable/Disable BGP route ECMP.

Available options:
no,
yes
​
conn_name
string

Connection name.

​
conn_bgp_prepend_as_path
string

Connection based BGP Prepend AS Path.

​
conn_bgp_send_communities
string

Connection based additional BGP communities to be sent.

​
conn_bgp_send_communities_additive
string

Do additive operation instead of replacement operation.

​
conn_bgp_send_communities_block
string

Block advertisement of any BGP communities on this connection.

​
active_standby
enum<string>

Enable/Disable Transit gateway in active-standby mode.

Available options:
no,
yes
​
active_standby_preemptive
boolean

Enable/Disable Transit gateway in active-standby preemptive mode.

​
del_csv_file
enum<string>

Delete input csv file.

Available options:
no,
yes
​
active_standby_switchover
string

Force switch over.

​
customize_transit_vpc_route
string

Edit customized transit VPC route.

​
summarize_cidr_to_tgw
enum<string>

Enable or disable summarization when propagate to TGW.

Available options:
no,
yes
​
multitier_transit
enum<string>

Enable or disable Multi-Tier Transit.

Available options:
no,
yes
​
show_route_cache
boolean

Show gateway route cache.

​
bgp_auto_refresh
enum<string>

Edit BGP auto refresh.

Available options:
no,
yes
​
show_bgp_auto_refresh
boolean

Show BGP auto refresh configuration.

​
configured_learned_cidr
string

Edit static learned cidr.

​
disable_route_propagation
enum<string>

Enable/Disable BGP spoke onprem route from propagating to attached transit.

Available options:
no,
yes
​
s2c_rx_balancing
enum<string>

Enable/Disable S2C Receive Packet Balancing.

Available options:
no,
yes
​
bgp_md5_key
string

Change BGP MD5 Key.

​
bgp_remote_ip
string

BGP remote ip.

​
edge_routing
enum<string>

Enabled/Disable edge spoke transitive routing.

Available options:
no,
yes
​
preserve_as_path
enum<string>

Preserve as_path when advertise manual summary cidrs.

Available options:
no,
yes
​
gre_keepalive_timeout
string

Configure GRE keepalive timeout 0(disable), or 8-86400s.

​
global_vpc
enum<string>

Configure GCE global vpc feature.

Available options:
no,
yes
​
conn_bgp_bfd
boolean

Whether to enable BFD on this connection.

​
bfd_rx_intv
integer

BGP BFD receive interval (ms) for the connection.

​
bfd_tx_intv
integer

BGP BFD transmit interval (ms) for the connection.

​
bfd_multiplier
integer

BGP BFD detect multiplier for the connection.

​
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