Skip to main content
POST
cURL

Body

application/json
​
connection_name
string
required

Connection Name.

​
vpc_id
string
required

Transit VPC ID.

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

​
auth_type
string

Auth type: pubkey or psk.

​
backup_bgp_md5_key
string

Backup BGP MD5 key.

​
backup_external_device_as_number
string

External device backup ASN.

​
backup_local_lan_ip
string

Local HA interface ip address.

​
backup_local_lan_ipv6_ip
string

Local HA interface ipv6 ip address for BGP over LAN.

​
backup_local_tunnel_ip
string

Address of tunnel interface on primary gateweay.

​
backup_pre_shared_key
string

Backup Pre-shared key.

​
backup_remote_lan_ip
string

External backup on-prem ip address.

​
backup_remote_lan_ipv6_ip
string

External backup on-prem ipv6 address.

​
backup_remote_tunnel_ip
string

Address of tunnel interface on backup gateway.

​
bfd_detect_multiplier
integer

BFD detect multiplier (only honored if --enable_bfd is set).

​
bfd_receive_interval
integer

BFD receive interval in ms (only honored if --enable_bfd is set).

​
bfd_transmit_interval
integer

BFD transmit interval in ms (only honored if --enable_bfd is set).

​
bgp_lan_activemesh
boolean

Enable activemesh BGP over LAN.

​
bgp_local_as_number
string

Local ASN.

​
bgp_md5_key
string

BGP MD5 key.

​
bgp_md5_key_changed
boolean

BGP connection MD5 key updated.

​
cert_name
string

Remote CA cert name for cert based S2C.

​
conn_learned_cidrs_approval
enum<string>

Connection learned cidrs approval.

Available options:
yes,
no
​
connection_policy
boolean

Enable connection policy for site2cloud connection.

​
direct_connect_backup
boolean

Backup over aws direct-connect.

​
direct_connect_primary
boolean

Primary over aws direct-connect.

​
disable_activemesh
boolean

Disable activemesh.

​
edge_underlay
boolean

Create edge underlay BGP connection.

​
enable_bfd
boolean

Enable BGP BFD on the connection at create time.

​
enable_bgp_multihop
boolean

Enable Multihop for BGP.

​
enable_global_accelerator
boolean

.

​
enable_ha
boolean

Enable HA.

​
enable_ikev2
boolean

Enable IKEv2.

​
external_device_as_number
string

External device ASN.

​
external_device_backup_ipv6
string

IPv6 Address of external backup device ip address(es).

​
external_device_ip_address
string

External device ip address(es).

​
external_device_ipv6
string

IPv6 Address of external device ip address(es).

​
ipv6_enabled
boolean

Enable IPv6 BGP peering.

​
jumbo_frame
boolean

Enabled jumbo frame for the connection.

​
local_device_ip
string

Local device tunnel ip address.

​
local_lan_ip
string

Local interface ip address.

​
local_lan_ipv6_ip
string

Local interface ipv6 ip address for BGP over LAN.

​
local_subnet
string

Local cidrs to remote peer.

​
local_tunnel_ip
string

Address of tunnel interface on primary gateweay.

​
log_file
string

Path to progress file.

​
peer_vnet_id
string

Peer VNET ID.

​
phase1_authentication
string

Phase 1 authentication algorithm.

​
phase1_dh_groups
string

Phase 1 DH group.

​
phase1_encryption
string

Phase 1 encryption algorithm.

​
phase2_authentication
string

Phase 2 authentication algorithm.

​
phase2_dh_groups
string

Phase 2 DH group.

​
phase2_encryption
string

Phase 2 encryption algorithm.

​
pre_shared_key
string

Pre-shared key.

​
proxy_id
enum<string>

Enable/disable proxy ID for static route-based IPSec connection.

Available options:
disable,
enable
​
remote_ha_identifier
string

Remote identifier for IKE config in HA gateway.

​
remote_identifier
string

Remote identifier for IKE config in primary gateway.

​
remote_lan_ip
string

External on-prem ip address.

​
remote_lan_ipv6_ip
string

External on-prem ipv6 address.

​
remote_subnet
string

Remote site CIDRs.

​
remote_tunnel_ip
string

Address of tunnel interface on backup gateway.

​
routing_protocol
enum<string>

Static or BGP routing.

Available options:
bgp,
static
​
transit_gw
string

Transit gateway name.

​
tunnel_protocol
enum<string>

Bgp link type.

Available options:
GRE,
IPsec,
LAN
​
vti_policy
boolean

Remote peer is running policy.

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