List BGP Neighbor Routes

Returns a list of BGP routes that have been advertised or received from a BGP peer. The list is a subset of the full list of BGP routes.

The productUid is the unique product ID for the MCR and is required.

Note: This endpoint is strictly rate limited and not intended for regular monitoring, only troubleshooting.

Running in Asynchronous mode

This endpoint must be run in asynchronous mode.

To use asynchronous mode, set the async parameter to True.

In asynchronous mode, the response is returned in a matter of milliseconds with no actual results, and a status of Pending. To retrieve the results, use the MCR productUid and the operationId returned in the response of this endpoint with the /v2/product/mcr2/{productUid}/diagnostics/routes/operation endpoint. This allows you to return routing tables in a low impact way.

Note: Synchronous mode has been deprecated and should not be used.

Path parameters

productUidstringRequired

Query parameters

directionstringOptional

An enum representing routes either received from, or advertised to the BGP neighbor. Values are either RECEIVED or ADVERTISED. (Enum - required)

peer_ip_addressstringOptional

IPv4 or IPv6 address of a BGP neighbor. (String - required)

asyncstringOptional

Whether the endpoint will be run in sync or async mode. (Boolean - required)

Response

List BGP Neighbor Routes - Async mode / List BGP Neighbor Routes - Async mode

datastringOptional

messagestringOptional

termsstringOptional