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

Calico BGPConfiguration API

The BGPConfiguration API from Calico — 2 operation(s) for bgpconfiguration.

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

Tagged areas include BGPConfiguration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://{kube_apiserver_host}/apis/projectcalico.org/v3.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Server
https://{kube_apiserver_host}/apis/projectcalico.org/v3
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Calico BGPConfiguration API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Kubernetes service account bearer token.

Paths & Operations 2

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

BGPConfiguration 2
GET
/bgpconfigurations
List BGPConfiguration
listBGPConfiguration → 200
GET
/bgpconfigurations/{name}
Read BGPConfiguration
readBGPConfiguration 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ObjectMeta (7 properties). Each schema is shown below with its type and property counts.

ObjectMeta
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calico-bgpconfiguration-api-openapi.yml Raw ↑

Other APIs Calico publishes across the network.

Calico Client API
calicoctl CLI
Calico Kubernetes CRDs
Calico BGPPeer API
Calico GlobalNetworkPolicy API
Calico HostEndpoint API
Calico IPPool API
Calico NetworkPolicy API
Calico Profile API