Transit or spoke gateway details

GET

/

v2

/

api

/

get_transit_or_spoke_gateway_details

cURL

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

import requests

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

gateway_name

string

required

Detailed info for a gateway.

option

enum<string>

Options for detailed info for a gateway.

Available options:

all,

best_routes,

details,

gateway_parameters,

gw_ifconf,

gw_route,

route_db,

spoke_gw_list,

vpc_route

transit_only

boolean

List transit vpc gw only.

spoke_only

boolean

List spoke vpc gw only.

transit_display_fields

boolean

Define the displayed fields for transit.

spoke_display_fields

boolean

Define the displayed fields for spoke.

table_name

string

Route table to be displayed.

cidr_filter

string

Cidr string to be filtered.

list_all_gateways_connections_info

boolean

List all gateways connections information. it combines each gateway connection info when options is details.

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

import requests

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