Site Edge Gateways

GET

api

list_edge_gateway_by_site_id

cURL

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

import requests

url = "https://<controller>/v2/api/list_edge_gateway_by_site_id"
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_edge_gateway_by_site_id", 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 associated with the login.

with_vpn

boolean

Only list VPCs with VPN gateways.

with_dns

boolean

Also list DNS.

with_site2cloud_conn

boolean

List VPCs that have site2cloud connections.

with_transit

boolean

List VPCs that has transit gateways.

bgp_capable

boolean

List VPCs that has BGP capable gateways.

refresh_tags

boolean

Whether to query tags from the cloud.

json_format

boolean

Return a json format.

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

import requests

url = "https://<controller>/v2/api/list_edge_gateway_by_site_id"
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_edge_gateway_by_site_id", 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 Edge Gateways by Site ID

Query Parameters

Response