Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Isovalent bgp API

The bgp API from Isovalent — 3 operation(s) for bgp.

Isovalent bgp API is one of 10 APIs that Isovalent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include bgp. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 2.0, at version v1beta1.

Requests are made against the base URL unix:///var/run/cilium/cilium.sock.

3 operations 3 paths 17 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v1beta1
Base URL
unix:///var/run/cilium/cilium.sock
Resource Areas
1

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

bgp 3
GET
/bgp/peersdeprecated
Lists operational state of BGP peers
→ 200500501
GET
/bgp/routesdeprecated
Lists BGP routes from BGP Control Plane RIB.
5 params → 200500501
GET
/bgp/route-policiesdeprecated
Lists BGP route policies configured in BGP Control Plane.
1 param → 200500501

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are BgpPeer (18 properties), BgpRoutePolicyStatement (8 properties), BgpPath (6 properties), BgpPeerFamilies (5 properties). Each schema is shown below with its type and property counts.

BgpNlri
object
Network Layer Reachability Information (NLRI) of the path
1 property
BgpRoutePolicyMatchType
string
Defines BGP route policy matching logic in case of multiple match elements.
BgpRoutePolicyStatement
object
Single BGP route policy statement
8 properties
BgpRoutePolicyPrefix
object
Matches a CIDR prefix in a BGP route policy
3 properties
BgpRoutePolicyPrefixMatch
object
Matches a CIDR prefix in a BGP route policy
2 properties
BgpRoutePolicy
object
Single BGP route policy retrieved from the underlying router Deprecated: This will be removed in the future.
4 properties
BgpPeerFamilies
object
BGP AFI SAFI state of the peer
5 properties
BgpRoute
object
Single BGP route retrieved from the RIB of underlying router Deprecated: This will be removed in the future.
4 properties
BgpFamily
object
Address Family Indicator (AFI) and Subsequent Address Family Indicator (SAFI) of the path
2 properties
Error
string
BgpRoutePolicyNexthopAction
object
BGP nexthop action
2 properties
BgpPeer
object
State of a BGP Peer Deprecated: This will be removed in the future. +k8s:deepcopy-gen=true
18 properties
BgpPath
object
Single BGP routing Path containing BGP Network Layer Reachability Information (NLRI) and path attributes
6 properties
BgpCapabilities
object
Represents the BGP capabilities.
1 property
BgpGracefulRestart
object
BGP graceful restart parameters negotiated with the peer.
2 properties
BgpPathAttribute
object
Single BGP path attribute specific for the path
1 property
BgpRoutePolicyNeighborMatch
object
Matches a neighbor in a BGP route policy
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

isovalent-bgp-api-openapi.yml Raw ↑

Other APIs Isovalent publishes across the network.

Hubble Observer API
Isovalent connectivity API
Isovalent daemon API
Isovalent endpoint API
Isovalent Healthz API
Isovalent ipam API
Isovalent policy API
Isovalent prefilter API
Isovalent service API