Networks

List BGP peers

get/networks/{network_id}/bgp-peers

View the dynamic routing (BGP) sessions configured on a private network. Each peer exchanges routes with one of your servers.

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

Responses

Successful Response

application/json

array<NetworkBGPPeerOut>

id*string

network_id*integer

peer_type*BGPPeerType

Value in"ip""vps""baremetal"

peer_target*string

remote_asn*integer

max_prefix*integer

description?string | null

enabled*boolean

created_at*string

Formatdate-time

resolved_peer_ip?string | null

last_state?string | null

prefixes_received?integer | null

last_state_at?string | null

Formatdate-time

received_prefixes?array<string>

Example request

GET/networks/{network_id}/bgp-peers

curl -X GET "https://api.cubepath.com/networks/1/bgp-peers" \
  -H "Authorization: Bearer $CUBEPATH_API_TOKEN"

Example response

[
  {
    "id": "string",
    "network_id": 1,
    "peer_type": "ip",
    "peer_target": "string",
    "remote_asn": 1,
    "max_prefix": 1,
    "description": "string",
    "enabled": true,
    "created_at": "2026-01-01T00:00:00Z",
    "resolved_peer_ip": "203.0.113.10",
    "last_state": "string",
    "prefixes_received": 1,
    "last_state_at": "2026-01-01T00:00:00Z",
    "received_prefixes": []
  }
]