Skip to main content
POST
/
service
/
{tenant_name}
/
bgp
/
neighbor
Create Tenant Neighbor
curl --request POST \
  --url https://api.example.com/service/{tenant_name}/bgp/neighbor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "remote_asn": 123,
  "remote_router_ip": "<string>",
  "update_source": "<string>",
  "password": "<string>",
  "passive": false,
  "pfx_list_in": "<string>",
  "pfx_list_out": "<string>",
  "max_pfx_in": 1000,
  "max_pfx_out": 1000,
  "keepalive": 123,
  "hold": 123,
  "open_delay": 0,
  "shutdown": false,
  "description": "<string>",
  "bfd_config": {
    "transmit_interval": 0,
    "receive_interval": 0,
    "detect_multiplier": 0,
    "passive_mode": false
  },
  "enable": true
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "received",
  "extra_details": {}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

Body

application/json
remote_asn
integer
required
remote_router_ip
string
required
update_source
string | null
password
string | null
passive
boolean
default:false
pfx_list_in
string | null
pfx_list_out
string | null
max_pfx_in
integer
default:1000
Required range: 0 <= x <= 1000
max_pfx_out
integer
default:1000
Required range: 0 <= x <= 1000
keepalive
integer | null
hold
integer | null
open_delay
integer
default:0
shutdown
boolean
default:false
description
string | null
bfd_config
BfdConfig · object
enable
boolean
default:true

Response

Successful Response

id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
status
enum<string>
required
Available options:
received,
in_progress,
success,
failed,
cancelled
extra_details
Extra Details · object