Networks

Update BGP peer

patch/networks/{network_id}/bgp-peers/{peer_id}

Adjust a dynamic routing (BGP) session: change its route limit, description, or enable/disable it.

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

peer_id*string

Request body

application/jsonRequired

max_prefix?integer | null

Range1 ≤ value ≤ 1000

description?string | null

enabled?boolean | null

Responses

Successful Response

application/json

detail*string

Example request

PATCH/networks/{network_id}/bgp-peers/{peer_id}

curl -X PATCH "https://api.cubepath.com/networks/1/bgp-peers/string" \
  -H "Authorization: Bearer $CUBEPATH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "max_prefix": 1,
  "description": "string",
  "enabled": true
}'

Example response

{
  "detail": "string"
}