Networks

Create BGP peer

post/networks/{network_id}/bgp-peers

Set up a dynamic routing (BGP) session so a server in your network can exchange routes automatically with the network gateway.

Authorization

Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Path parameters

network_id*integer

Range1 ≤ value

Request body

application/jsonRequired

peer_type*BGPPeerType

Value in"ip""vps""baremetal"

peer_target*string

remote_asn*integer

Range1 ≤ value ≤ 4294967295

max_prefix?integer

Range1 ≤ value ≤ 1000Default100

description?string | null

Responses

Successful Response

application/json

detail*string

peer_id*string

peer_type*string

peer_target*string

remote_asn*integer

Example request

POST/networks/{network_id}/bgp-peers

curl -X POST "https://api.cubepath.com/networks/1/bgp-peers" \
  -H "Authorization: Bearer $CUBEPATH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "peer_type": "vps",
  "peer_target": "123",
  "remote_asn": 65010,
  "max_prefix": 100,
  "description": "On-prem router via VPN appliance"
}'

Example response

{
  "detail": "string",
  "peer_id": "string",
  "peer_type": "string",
  "peer_target": "string",
  "remote_asn": 1
}