List gateways

GET

api

list_gateways

cURL

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

import requests

url = "https://<controller>/v2/api/list_gateways"
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", 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

account_name

string

Account name.

vpc_id

string

VPC id.

nfq

boolean

NFQ related config.

transit

boolean

List only transit gateway.

with_imported_cert

boolean

List only Gateways that have cert imported.

with_cert

boolean

List only Gateways that have cert generated by controller.

include_hagw

boolean

Include HAGW.

cloud_type

string

List only Gateway for specific Cloud.

exclude_bgp_spokes

boolean

Exclude BGP spoke gateway names when creating new Site2Cloud connection.

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" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/list_gateways"
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", 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
}

Concepts & Architecture

Guides

Reference

List gateways

Query Parameters

Response