API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Modify BGP profile

BGP routing profile containing a single router instance per
Autonomous System. Each entity is identified by profile name.
Configure AS number, VRF instances, neighbors, route policies,
timers, and address families. Use these APIs to create, modify, or
delete a BGP profile.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Name of the BGP Profile.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

string
length between 1 and 256

Description of the BGP Profile.

string
length between 1 and 256

Name of the BGP Profile.

string
enum

Type of the platform (GW, PVOS, CX).

Show Details
APAccess Point.
BRIDGEBRIDGE DIA
CX_SWITCHCX Switch.
GATEWAYGateway.
PVOS_SWITCHPVOS Switch.
Allowed:
router
array of objects
length ≤ 2147483647

BGP Router instance. Each BGP profile supports only ONE router instance (single Autonomous System). The router is identified by a unique AS number that must be consistent across the profile. Multiple AS numbers are not allowed within the same BGP profile. Each instance contains complete BGP configuration including neighbor/peer relationships (internal iBGP and external eBGP), routing policies, keepalive/hold timers, address family configurations (IPv4, IPv6, VPNv4), graceful restart, route reflection, and best path selection

router
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json