List gateways details

GET

/

v2

/

api

/

list_gateways_details

cURL

curl -sk -X GET "https://<controller>/v2/api/list_gateways_details" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/list_gateways_details"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/list_gateways_details", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

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.

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

⌘I

cURL

curl -sk -X GET "https://<controller>/v2/api/list_gateways_details" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/list_gateways_details"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/list_gateways_details", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}