Skip to main content
POST
cURL

Body

application/json
attachment_name
string
required

Attachment, e.g. VPC ID.

edge_attachment
string
required

Configure management access from AVX_EDGE_DOMAIN.

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

Direct Connect allowed prefix.

approved_learned_cidrs
string

Approved learned cidrs.

conn_name
string

TGW attachment connection name.

connect_peer_id
string

TGW Connect peer ID.

connect_peer_name
string

TGW Connect peer name.

disable_local_propagation
boolean

Disable local propagation.

include_avx
boolean

Include avx attachment.

inside_ip_cidr
string

TGW Connect inside CIDR block.

learned_cidrs_approval
enum<string>

Learned cidrs approval.

Available options:
yes,
no
peer_asn
string

TGW Connect peer ASN number.

peer_ip_address
string

TGW Connect peer IP address.

pending_learned_cidrs
string

Pending learned cidrs.

region
string

Region.

resource_type
string

Filter the list_names with a specific type.

route_domain_name
string

A route domain name.

route_list
string

A list of CIDRs.

tgw_ip_address
string

TGW IP address.

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