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

IP address management and allocation

Cilium IPAM API is one of 11 APIs that Cilium publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IPAM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and a changelog.

This API exposes 4 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.

4 operations 3 paths 7 schemas 1 DELETE1 GET2 POST

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 4

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

IPAM 4

IP address management and allocation

POST
/ipam
Cilium Allocate IP address
allocateIPAddress 3 params → 201502
POST
/ipam/{ip}
Cilium Allocate specific IP address
allocateSpecificIPAddress 3 params → 200400409500
DELETE
/ipam/{ip}
Cilium Release IP address
releaseIPAddress 2 params → 200400404500
GET
/ip
Cilium List IP addresses
listIPAddresses → 200500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are IPAMResponse (4 properties), IPAMAddressResponse (4 properties), NodeAddressingElement (4 properties), IPListEntry (3 properties). Each schema is shown below with its type and property counts.

AddressPair
object
IPv4 and IPv6 address pair for an endpoint.
2 properties
NodeAddressing
object
IP addressing information for the host node.
2 properties
IPListEntry
object
Information about a single IP address known to the Cilium agent.
3 properties
NodeAddressingElement
object
Node addressing for a single address family.
4 properties
IPAMAddressResponse
object
Details of a single allocated IP address.
4 properties
IPAMResponse
object
Response from an IP address allocation request.
4 properties
Error
string
Human-readable error message.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cilium-ipam-api-openapi.yml Raw ↑

Other APIs Cilium publishes across the network.

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