Skip to main content
GET
cURL

Query Parameters

region
enum<string>
required

A vpc region.

Available options:
,
acs-ap-northeast-1 (Tokyo),
acs-ap-south-1 (Mumbai),
acs-ap-southeast-1 (Singapore),
acs-ap-southeast-2 (Sydney),
acs-ap-southeast-3 (Kuala Lumpur),
acs-ap-southeast-5 (Jakarta),
acs-cn-beijing (Beijing),
acs-cn-chengdu (Chengdu),
acs-cn-guangzhou (Guangzhou),
acs-cn-hangzhou (Hangzhou),
acs-cn-heyuan (Heyuan),
acs-cn-hongkong (Hongkong),
acs-cn-huhehaote (Hohhot),
acs-cn-qingdao (Qingdao),
acs-cn-shanghai (Shanghai),
acs-cn-shenzhen (Shenzhen),
acs-cn-wulanchabu (Ulanqab),
acs-cn-zhangjiakou (Zhangjiakou),
acs-eu-central-1 (Frankfurt),
acs-eu-west-1 (London),
acs-me-central-1 (Riyadh),
acs-me-east-1 (Dubai),
acs-us-east-1 (Virginia),
acs-us-west-1 (Silicon Valley),
ap-chuncheon-1,
ap-hyderabad-1,
ap-melbourne-1,
ap-mumbai-1,
ap-osaka-1,
ap-seoul-1,
ap-singapore-1,
ap-singapore-2,
ap-sydney-1,
ap-tokyo-1,
avx-edge-default,
ca-montreal-1,
ca-toronto-1,
eu-amsterdam-1,
eu-frankfurt-1,
eu-madrid-1,
eu-marseille-1,
eu-milan-1,
eu-paris-1,
eu-stockholm-1,
eu-zurich-1,
il-jerusalem-1,
me-abudhabi-1,
me-dubai-1,
me-jeddah-1,
me-riyadh-1,
mx-monterrey-1,
mx-queretaro-1,
sa-bogota-1,
sa-santiago-1,
sa-saopaulo-1,
sa-valparaiso-1,
sa-vinhedo-1,
uk-cardiff-1,
uk-london-1,
us-ashburn-1,
us-chicago-1,
us-langley-1,
us-luke-1,
us-phoenix-1,
us-sanjose-1
account_name
string
required

An account name.

cloud_type
enum<integer>
required

Cloud type.

Available options:
1,
4,
8,
16,
32,
256,
1024,
2048,
4096,
8192
private_subnets
boolean

Include private subnets as well.

json_format
boolean

Display in json.

include_shared_vpc
boolean

Include shared vpc.

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