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 BGPPeer API

The BGPPeer API from Calico — 2 operation(s) for bgppeer.

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

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

This API exposes 5 operations across 2 paths, and defines 5 schemas. 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.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

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 BGPPeer 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 5

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

BGPPeer 5
GET
/bgppeers
List BGPPeer
listBGPPeer → 200
POST
/bgppeers
Create BGPPeer
createBGPPeer body → 201
GET
/bgppeers/{name}
Read BGPPeer
readBGPPeer 1 param → 200
PUT
/bgppeers/{name}
Replace BGPPeer
replaceBGPPeer 1 param body → 200
DELETE
/bgppeers/{name}
Delete BGPPeer
deleteBGPPeer 1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are BGPPeerSpec (10 properties), ObjectMeta (7 properties), Status (6 properties), BGPPeer (4 properties). Each schema is shown below with its type and property counts.

ObjectMeta
object
7 properties
BGPPeer
object
4 properties 4 required
Status
object
6 properties
BGPPeerList
object
3 properties
BGPPeerSpec
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calico-bgppeer-api-openapi.yml Raw ↑

Other APIs Calico publishes across the network.

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