List route domain names

GET

/

v2

/

api

/

list_route_domain_names

cURL

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

import requests

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

acct_name

string

Account name.

region

string

Region.

tgw_name

string

required

TGW name.

route_domain_name

string

Route domain name.

domain_name_to_change

string

Route domain name to add or delete.

connected_rds

string

List of connected route domain names.

firewall_domain

boolean

Create firewall domain.

native_firewall_domain

boolean

Create native firewall domain.

egress_domain

boolean

Create egress domain.

enable_inspection

boolean

Enable intra domain inspection.

firewall_domain_name

string

Firewall Domain name.

log_file

string

Full path of the progress log file.

force

boolean

Allow to delete system domains.

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

import requests

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