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

The ipam API from Isovalent — 2 operation(s) for ipam.

Isovalent ipam API is one of 10 APIs that Isovalent 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 and API documentation.

This API exposes 3 operations across 2 paths, and defines 6 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 2 paths 6 schemas 1 DELETE2 POST

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 2 paths, the API surfaces 3 operations — 1 DELETE, 2 POST. Each is listed below with its method, path, parameters, and response codes.

ipam 3
POST
/ipam
Allocate an IP address
4 params → 201403502
POST
/ipam/{ip}
Allocate an IP address
3 params → 200400403409500501
DELETE
/ipam/{ip}
Release an allocated IP address
2 params → 200400403404500501

Schemas 6

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

IPAMAddressResponse
object
IPAM configuration of an individual address family
7 properties
NodeAddressingElement
object
Addressing information
4 properties
IPAMResponse
object
IPAM configuration of an endpoint
4 properties 2 required
Error
string
AddressPair
object
Addressing information of an endpoint
6 properties
NodeAddressing
object
Addressing information of a node for all address families +k8s:deepcopy-gen=true
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

isovalent-ipam-api-openapi.yml Raw ↑

Other APIs Isovalent publishes across the network.

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