Skip to main content
POST
cURL

Body

application/json
connect_attachment_id
string
required

Attachment, e.g. VPC ID.

tgw_name
string
required

TGW name.

CID
string

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

acct_name
string

Account name.

action
string

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

allowed_prefix
string

Allowed prefix CIDRs for DX.

attachment_acct
string

Attachment account.

avx_gw_name
string

The AVX transit gw name.

aws_side_asn
string

AWS side ASN number.

cloud_type
enum<integer>

Cloud type.

Available options:
1,
256
conn_name
string

Vpn, DX, TGW Connect or TGW peering connection name.

customized_routes
string

Customized routes.

customized_routes_advertise
string

Customized routes advertise list.

disable_local_propagation
boolean

Disable local route propagation to its own domain.

dx_gateway_id
string

Direct Connect Gateway ID.

edge_dx
boolean

Native_edge_dx attachment.

edge_vpn
boolean

Native_edge_vpn attachment.

enable_acceleration
boolean

Enable VPN Acceleration.

firewall_domain
boolean

Add attachment to firewall domain.

inside_ip_cidr_tun_1
string

Inside IP CIDR for Tunnel 1.

inside_ip_cidr_tun_2
string

Inside IP CIDR for Tunnel 2.

learned_cidrs_approval
enum<string>

Learned cidrs approval.

Available options:
yes,
no
log_file
string

Full path of the progress log file.

multicast_enable
boolean

Enable multicast on the transit gateway.

not_create_default_domains
boolean

Do not create default domains.

peer_route_domain_name
string

Peer TGW route domain name.

peer_tgw_name
string

Peer AWS TGW name.

pre_shared_key_tun_1
string

Pre-Shared Key for Tunnel 1.

pre_shared_key_tun_2
string

Pre-Shared Key for Tunnel 2.

protocol
string

TGW Connect protocol.

public_ip
string

Public IP for CGW.

region
string

Region.

remote_cidrs
string

Static remote CIDR list.

route_domain_name
string

A route domain name.

route_table_list
string

Route table list.

subnet_list
string

A list of subnets.

summarize_rfc1918
enum<string>

Enable/disable summarize RFC1918 routes in VPC route table.

Available options:
yes,
no
tgw_cidr_list
string

TGW CIDR list.

tgw_connect
boolean

Native_tgw_connect attachment.

tgw_peering
boolean

Native_tgw_peering attachment.

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