Skip to main content
POST
cURL

Body

application/json
​
account_name
string
required

AWS account name.

​
cloud_type
enum<integer>
required

Cloud type.

Available options:
1,
4,
8,
16,
32,
256,
1024,
2048,
8192
​
pool_name
string
required

A unique vpc name prefix .

​
vpc_cidr
string
required

Vpc_cidr.

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

​
add_gateway
enum<string>

Launch a gateway for each VPC in the pool.

Available options:
yes,
no
​
aviatrix_firenet_vpc
boolean

Aviatrix FireNet VPC.

​
aviatrix_transit_vpc
boolean

Aviatrix Transit VPC.

​
designated_gateway
boolean

This gateway is used as Designated routing gateway.

​
enable_ipv6
boolean

Enable ipv6 for the VPC.

​
enable_nat
enum<string>

Enable NAT for launched gateway.

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

(GCP only) IPv6 access type. EXTERNAL: Google auto-allocates public IPv6. INTERNAL: Use ULA (Unique Local Address) IPv6 range.

Available options:
EXTERNAL,
INTERNAL
​
log_file
string

Full path of the progress log file.

​
num_of_subnets
string

Pairs of public and private subnets to create.

​
num_of_vpc
string

Number of VPCs to create in the pool.

​
num_of_zones
string

Number of availability zones to create subnet.

​
private_oob_subnets
boolean

Create private management subnets.

​
public_subnets
string

If this VPC should have public subnets. Default is yes. Enter no if you do not allow.

​
region
string

A vpc region.

​
resource_group
string

Azure resource group.

​
security_url
string

List of S3 url scripts in CloudFormation format to apply to this VPC. Use | to separate urls. Use profile_default if you are not sure.

​
subnet_bit_length
string

Number of bits to be used as subnet.

​
subnet_list
string

List of subnets to be added.

​
subnet_size
string

VPC subnet size.

​
vpc_ipv6_cidr
string

IPv6 CIDR block for the VPC/VNet. Required for Azure when IPv6 is enabled. For GCP INTERNAL access type, this specifies the custom ULA range (e.g., fd00::/48).

​
vpc_size
string

Instance size of vpc cloudx.

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