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

Cilium BGP API

BGP control plane peers, routes, and route policies

Cilium BGP API is one of 11 APIs that Cilium 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, API documentation, a getting-started guide, and a changelog.

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

Requests are made against a single base URL, http://localhost/v1.

3 operations 3 paths 7 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1beta1
Base URL
https://localhost/v1
Terms of Service
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

BGP control plane peers, routes, and route policies

GET
/bgp/peers
Cilium List BGP peers
getBGPPeers → 200500
GET
/bgp/routes
Cilium List BGP routes
getBGPRoutes 5 params → 200500
GET
/bgp/route-policies
Cilium List BGP route policies
getBGPRoutePolicies 1 param → 200500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are BgpPath (7 properties), BgpPeer (6 properties), BgpFamily (4 properties), BgpRoute (4 properties). Each schema is shown below with its type and property counts.

BgpRoutePolicy
object
A BGP route policy for filtering or modifying routes.
3 properties
BgpRoutePolicyStatement
object
A single statement in a BGP route policy.
3 properties
BgpPeer
object
Status information for a single BGP peer.
6 properties
BgpRoute
object
A single BGP route entry.
4 properties
BgpPath
object
BGP path attributes for a route.
7 properties
Error
string
Human-readable error message.
BgpFamily
object
A BGP address family (AFI/SAFI combination).
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cilium-bgp-api-openapi.yml Raw ↑

Other APIs Cilium publishes across the network.

Hubble API
Tetragon API
Hubble Relay API
Cilium Daemon API
Cilium Endpoint API
Cilium IPAM API
Cilium Lrp API
Cilium Policy API
Cilium Prefilter API
Cilium Service API