CIcilium
bgp

Lists BGP routes from BGP Control Plane RIB.

Changed on

Retrieves routes from BGP Control Plane RIB filtered by parameters you specify. Deprecated: This will be removed in the future.

get/bgp/routes

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Query parameters

table_type'loc-rib' | 'adj-rib-in' | 'adj-rib-out' required

BGP Routing Information Base (RIB) table type

afistring required

Address Family Indicator (AFI) of a BGP route

safistring required

Subsequent Address Family Indicator (SAFI) of a BGP route

router_asninteger

Autonomous System Number (ASN) identifying a BGP virtual router instance. If not specified, all virtual router instances are selected.

neighborstring

IP address specifying a BGP neighbor. Has to be specified only when table type is adj-rib-in or adj-rib-out.

Response

Success

router-asninteger

Autonomous System Number (ASN) identifying a BGP virtual router instance

neighborstring

IP address specifying a BGP neighbor if the source table type is adj-rib-in or adj-rib-out

prefixstring

IP prefix of the route

Changes