Skip to main content
GET
cURL

Query Parameters

vpc_type
enum<string>

VPC type.

Available options:
vpc_legacy
vpn_gw_only
enum<string>

List vpn enabled gateway only. A boolean choice expressed as a string

Available options:
yes,
no
account_name
string

Account name (default: admin).

acx_gw_only
enum<string>

List acx gateways only. A boolean choice expressed as a string

Available options:
yes,
no
transit_only
boolean

List transit vpc gw only.

spoke_only
boolean

List spoke vpc gw only.

active_only
boolean

List active gw only.

bgp_only
boolean

List all transit and BGP enabled spoke gateways.

bgp_spoke_only
boolean

List BGP enabled spoke gateways only.

vpc_id
string

Vpc_id.

fqdn_only
boolean

Active fqdn gw only.

ps3_only
boolean

Private s3 gw only.

ui_display
enum<string>

Return gateway alias name if yes. A boolean choice expressed as a string

Available options:
yes,
no
gateway_name
string

To specify the particular gateway.

include_gateway_info
boolean

VPC summary will include all gateway details, which can be retrieved by list_vpc_by_name.

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