Skip to main content
POST
cURL

Body

application/json
bgp_neighbor_status_polling_time
integer
required

Configure BGP neighbor status polling time (1-10)sec.

gateway_name
string
required

BGP gateway name.

CID
string

The opaque session ID token. Required for 7.2 controllers only.

accept_communities
string

Accept BGP communities from peers.

action
string

The API action to perform. Required for 7.2 controllers only.

bgp_hold_time
string

Configure BGP polling time (12-360)sec.

bgp_local_as_num
string

BGP local AS number.

bgp_polling_time
string

Configure BGP route polling time (10-50)sec.

dampening
enum<string>

Enable or disable bgp dampening.

Available options:
false,
true
mode
enum<string>

Enable or disable BGP GW configuration.

Available options:
disable,
enable
send_communities
string

Send BGP communities to peers.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype
string

Error type if the API failed.

reason
string

Failure reason if the API failed.

results

API response data

return
boolean

Whether the API returned successfully