Skip to main content
GET
/
service
/
{tenant_name}
/
bgp
/
neighbor
Get All Tenant Neighbors
curl --request GET \
  --url https://api.example.com/service/{tenant_name}/bgp/neighbor \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "remote_router_ip": "<string>",
      "remote_asn": 123,
      "max_pfx_in": 123,
      "max_pfx_out": 123,
      "open_delay": 123,
      "shutdown": true,
      "id": 123,
      "autonomous_system_id": 123,
      "autonomous_system": {
        "asn": 123,
        "keepalive": 123,
        "hold": 123,
        "tenant_name": "<string>",
        "id": 123
      },
      "tenant_name": "<string>",
      "update_source": "<string>",
      "password": "<string>",
      "passive": false,
      "route_map_in_id": 123,
      "route_map_out_id": 123,
      "keepalive": 123,
      "hold": 123,
      "description": "<string>",
      "bfd_config": {
        "transmit_interval": 0,
        "receive_interval": 0,
        "detect_multiplier": 0,
        "passive_mode": false
      },
      "enable": true,
      "connected_vi": "",
      "pfx_list_in": "<string>",
      "pfx_list_out": "<string>",
      "is_dia": false
    }
  ],
  "count": 0,
  "total_count": 0
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

Query Parameters

limit
integer
default:0
offset
integer
default:0

Response

Successful Response

items
(NBNeighbor · object | NBDiaNeighbor · object)[]
required
count
integer
default:0
total_count
integer
default:0