Add route domain

POST

/

v2

/

api

/

add_route_domain

cURL

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

import requests

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

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

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/add_route_domain", 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
}

Body

application/json

route_domain_name

string

required

Route domain name.

tgw_name

string

required

TGW name.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

acct_name

string

Account name.

action

string

The API action to perform. Required for 7.2 controllers only.

connected_rds

string

List of connected route domain names.

domain_name_to_change

string

Route domain name to add or delete.

enable_inspection

boolean

Enable intra domain inspection.

firewall_domain

boolean

Create firewall domain.

firewall_domain_name

string

Firewall Domain name.

force

boolean

Allow to delete system domains.

log_file

string

Full path of the progress log file.

native_egress_domain

boolean

Create egress domain.

native_firewall_domain

boolean

Create native firewall domain.

region

string

Region.

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 POST "https://<controller>/v2/api/add_route_domain" \
  -H "Authorization: cid <CID>"

import requests

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

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

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/add_route_domain", 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
}