Skip to main content
GET
cURL

Query Parameters

​
account_name
string
required

EdgeCSP Controller account.

​
serial
string

Serial number of the device.

​
hardware_model
string

The hardware model of the edge device.

​
device_name
string

Optional name for the edge device.

​
network
string

Network configuration when onboarding a device.

​
direct_attach_lan
boolean

.

​
list_svg
boolean

.

​
reset_token
string

Device factory reset token.

​
proxy_id
string

ID of the proxy profile.

​
proxy_name
string

Name of the proxy profile.

​
address
string

IP address.

​
port
integer

Port number.

​
ca_cert
string

Base64-encoded CA certificate.

​
name
string

Name for the Aviatrix Edge gateway instance.

​
site_id
string

Optional site id.

​
mgmt_egress_ip
string

IP cidr for controller to reach gateway.

​
mgmt_over_private_network
boolean

Indicate that Gateway to controller traffic is over a private network.

​
dhcp
boolean

Use DHCP for management interface.

​
mgmt_ip
string

Static IP for mgmt interface, in CIDR notation.

​
mgmt_default_gateway
string

Default gateway for mgmt interface.

​
dns_server_ip
string

User provided DNS server IP.

​
dns_server_ip_secondary
string

User provided secondary DNS server IP.

​
hpe
boolean

Use high performance encryption for this Aviatrix Edge gateway.

​
wan_ip
string

WAN IP to connect to transit gateways.

​
wan_default_gateway
string

Default gateway for the WAN interface.

​
lan_ip
string

LAN IP to connect to on premises network.

​
lan_default_gateway
string

Default gateway for LAN network.

​
do_not_delete_iso
boolean

Keep ISO file on the controller.

​
cloud_init
boolean

Supports cloud-init instead of ISO data.

​
enable_active_standby
boolean

Supports edge gateways in active-standby mode.

​
disable_active_standby
boolean

Disables edge gateways active-standby mode.

​
enable_active_standby_preemptive
boolean

Supports edge gateways in active-standby preemptive mode.

​
wan_discovery_ip
string

Edit wan discovery public ip.

​
wan_interface
string

WAN discovery interface.

​
logical_wan_interface
string

WAN discovery on logical wan interface.

​
disable_active_standby_preemptive
boolean

Disables edge gateways active-standby preemptive mode.

​
default_mgmt_interface
string

The host interface to be used as mgmt, by default it is eth2.

​
guest_mgmt_interfaces
string

Guest management interfaces.

​
interfaces
string

Interface configuration.

​
vlan
string

VLAN configuration.

​
auto_advertise_lan_cidrs
enum<string>

Enable/Disable edge gateway auto adverise lan cidrs.

Available options:
disable,
enable
​
is_bgp_configured
boolean

Enable/Disable BGP on edge gateway.

​
bgp_local_as_num
string

Local BGP ASN.

​
cloud_type
integer

Edge platform type.

​
native_vlan
string

Native vlan-id.

​
is_transit
boolean

Creates Edge as a transit gateway.

​
eip_map
string

Public IP mapping for the gateway wan interfaces.

​
logical_intf_eip_map
string

Public IP mapping for the gateway wan logical interfaces.

​
gw_size
string

Edge gateway size.

​
phase2_encryption
string

Phase 2 encryption policy for the gateway.

​
phase2_dh
string

Phase 2 PFS policy for the gateway.

​
group_uuid
string

Gateway group uuid for the gateway.

​
device_id
string
required

Device UUID of the edge device.

​
wan_ifnames
string

Comma separated list of host WAN interfacess on the edge gateway VM.

​
lan_ifnames
string

Comma separated list LAN host interface names on the edge gateway VM.

​
mgmt_ifnames
string

Comma separated list of Management host interface names on the edge gateway VM.

​
gw_resource_size
string

Size of gw in terms of CPU and Memory, see edge csp API for choices.

​
no_progress_bar
boolean

Do not show gateway creation progress bar.

​
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