Policy > Networking > Connectivity > Tier-0 Gateways > Routing > BGP

Associated URIs:

API Description API Path

Read BGP routing config


Read BGP routing config
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp

Create or update BGP routing config


If an BGP routing config not present, create BGP routing config.
If it already exists, update the routing config.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
PATCH /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp

Create or update a BGP routing config


If BGP routing config is not already present, create BGP routing config.
If it already exists, replace the BGP routing config with this object.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp
PUT /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp

List BGP neighbor configurations


Paginated list of all BGP neighbor configurations
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors

Delete BGP neighbor config


Delete BGP neighbor config
DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
DELETE /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>

Read BGP neighbor config


Read BGP neighbor config
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>

Create or update a BGP neighbor config


If BGP neighbor config with the neighbor-id is not already present, create a new
neighbor config. If it already exists, replace the BGP neighbor config with this object.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
PATCH /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>

Create or update a BGP neighbor config


If BGP neighbor config with the neighbor-id is not already present, create a new
neighbor config. If it already exists, replace the BGP neighbor config with this object.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
PUT /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>

Get BGP neighbor advertised routes


Returns routes advertised by BGP neighbor from all edge transport nodes on which
this neighbor is currently enabled.
The query parameter "source=cached" is not supported.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes

Get BGP neighbor advertised routes in CSV format


Returns routes advertised by BGP neighbor from all edge transport nodes on which
this neighbor is currently enabled in CSV format. Routes from all enforcement points are returned.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes?format=csv

Get routes learned by BGP neighbor in CSV format


Returns routes learned by BGP neighbor from all edge nodes on which
this neighbor is currently enabled. Routes from all enforcement points are returned.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/routes?format=csv

Get routes learned by BGP neighbor


Returns routes learned by BGP neighbor from all edge nodes on which
this neighbor is currently enabled.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/routes

Get BGP neighbor status for the Tier0


Returns the status of all the BGP neighbors for the given Tier0.
To get BGP neighbor status for a particular enforcement point,
parameter "enforcement_point_path=" needs to be specified.
If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched.
To get BGP neighbors status for the logical router from particular edge node,
parameter "edge_path=" needs to be specified.
If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/status