Skip to main content
GET
/
service
/
{tenant_name}
/
bgp
/
neighbor
/
{remote_router_ip}
Get Tenant Neighbor By Ip
curl --request GET \
  --url https://api.example.com/service/{tenant_name}/bgp/neighbor/{remote_router_ip} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Authorizations

Authorization
string
header
required

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

Path Parameters

remote_router_ip
required

Response

Successful Response

remote_router_ip
string
required
remote_asn
integer
required
max_pfx_in
integer
required
max_pfx_out
integer
required
open_delay
integer
required
shutdown
boolean
required
id
integer
required
autonomous_system_id
integer
required
autonomous_system
AutonomousSystem · object
required
tenant_name
string | null
update_source
string | null
password
string | null
passive
boolean
default:false
route_map_in_id
integer | null
route_map_out_id
integer | null
keepalive
integer | null
hold
integer | null
description
string | null
bfd_config
BfdConfig · object
enable
boolean
default:true
connected_vi
string
default:""
pfx_list_in
string | null
pfx_list_out
string | null
is_dia
boolean
default:false