Peer VPC pair

POST

api

peer_vpc_pair

cURL

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

import requests

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

vpc_name1

string

required

A unique VPC name.

vpc_name2

string

required

A unique VPC name.

CID

string

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

action

string

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

cluster

enum<string>

Triggeed by cluster peering.

Available options:

yes,

no

from_spoke_transit

enum<string>

Spoke to Transit peering.

Available options:

yes,

no

ha_enabled

enum<string>

Enable peer ha.

Available options:

yes,

no

over_aws_peering

enum<string>

Encryped peering over an aws peering.

Available options:

yes,

no

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

import requests

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

Peer VPC pair

Body

Response