Skip to main content
GET
cURL

Query Parameters

cloud_type
integer

Cloud type int.

account_name
string

Account name for Aviatrix CoPilotVM.

region
string

Region Name.

zone
string

Zone Name.

vpc_id
string

The CoPilot VPC or VNET ID.

instance_id
string

CoPilot Instance ID.

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