Skip to main content
GET
cURL

Query Parameters

​
gateway_name
string
required

Gateway name.

​
alias_name
string

Gateway alias name.

​
delete_alias_name
boolean

Delete gateway alias name.

​
gw_size
string

Gateway size.

​
extended_cidrs
string

Extended public CIDRs.

​
enable_nat
enum<string>

Switch snat config for gateway. A boolean choice expressed as a string

Available options:
yes,
no
​
secondary_ip
boolean

SNAT to secondary Ips.

​
use_vpc_dns_server
enum<string>

Enable or disable using VPC DNS server.

Available options:
disable,
enable
​
gw_auto_restart
enum<string>

Gateway auto restart config. A boolean choice expressed as a string

Available options:
yes,
no
​
migrate_gw_public_ip
string

Migrate gateway Public IP.

​
monitor_subnets_action
enum<string>

Monitor gateway subnets for user instance.

Available options:
disable,
enable
​
monitor_exclude_gw_list
string

Monitor gateway subnets excluded list.

​
disable_skip_rfc1918_routes
enum<string>

Disable skip rfc1918 route programming.

Available options:
disable
​
exclude_ctrler_ipsec_policy
enum<string>

Enable/disable to exclude controller ipsec policy.

Available options:
disable,
enable
​
edit_designated_gateway
enum<string>

Edit designated gateway.

Available options:
edit
​
additional_cidr_list
string

Edit designated gateway CIDR list.

​
edit_secondary_ip
string

Add secondary IP addresses.

​
encrypt_ebs
boolean

Encrypt gateway volume.

​
cmk
string

Customer managed key.

​
customizing_gateway_route
enum<string>

Edit customized gateway route.

Available options:
edit
​
customized_cidr_list
string

Edit customized gateway CIDR list.

​
filtering_gateway_route
enum<string>

Edit filtering gateway route.

Available options:
edit
​
filtering_cidr_list
string

Edit filtering gateway CIDR list.

​
advertise_gateway_route
enum<string>

Edit advertise gateway route.

Available options:
edit
​
advertise_cidr_list
string

Edit advertise gateway CIDR list.

​
advertise_lan_static_route_list
string

Edit advertise gateway lan static route list.

​
transit_peering_as_onprem_backup
enum<string>

Enable or disable transit peering as onprem backup.

Available options:
disable,
enable
​
enable_activemesh
enum<string>

Enable/Disable gateway ActiveMesh mode. A boolean choice expressed as a string

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

Enable/Disable VPC private route tables with default route 0.0.0.0/0.

Available options:
disable,
enable,
show
​
ipv6_action
enum<string>

Enable/Disable gateway IPv6 feature.

Available options:
disable,
enable,
enable_vpn
​
update_vpc_cidr
boolean

Update gateway VPC CIDR list.

​
update_spoke_vpc_route_table
boolean

Update spoke VPC route table.

​
edit_private_route_tables
enum<string>

Yes or no. A boolean choice expressed as a string

Available options:
yes,
no
​
private_route_tables
string

String of comma separated route table names.

​
route_tables
string

Comma-separated managed route table IDs (required when action is edit_managed_route_tables, empty clears).

​
log_file
string

Full path of the progress log file.

​
rollback
boolean

Rollback to old image.

​
jumbo_frame
enum<string>

Enable/Disable jumbo frame support.

Available options:
disable,
enable,
show
​
gro_gso
enum<string>

Enable/Disable GRO and GSO.

Available options:
disable,
enable,
show
​
rx_queue_size
string

Edit gateway RX queue size.

​
show_rx_queue_size
boolean

Show gateway RX queue size.

​
auto_advertise_s2c_cidrs
enum<string>

Enable/Disable spoke gateway auto advertise s2c virtual cidrs.

Available options:
disable,
enable,
show,
show_list
​
biflow
enum<string>

Enable/Disable biflow routing for all CSP destinations behind this spoke.

Available options:
disable,
enable,
show
​
smart_gw_underlay
enum<string>

Enable/Disable/Show per-gateway-group GoBGP underlay (Smart Gateway Flag 2).

Available options:
disable,
enable,
show
​
smart_gw_resolver
enum<string>

Enable/Disable/Show per-gateway-group recursive route resolver (Smart Gateway Flag 3).

Available options:
disable,
enable,
show
​
ipsla_txlb
enum<string>

Enable/Disable Ipsla Txlb on edge gateway for all traffic towards CSP destinations.

Available options:
disable,
enable,
show
​
bgp_over_lan
enum<string>

Enable/Disable BGP over LAN.

Available options:
disable,
enable
​
bgp_over_lan_intf_cnt
integer

BGP over LAN interface count.

​
replace_existing_routes
boolean

Overwrite existing routes and replace with Aviatrix routes.

​
refresh_route_table_ids
string

Add/replace Aviatrix routes in specific known route tables (comma separated string).

​
refresh_all_route_tables
boolean

Add/replace Aviatrix routes in all known route tables.

​
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