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

Cilium daemon configuration, health, and cluster management

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

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

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

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

7 operations 6 paths 30 schemas 6 GET1 PATCH

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 7

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

Daemon 7

Cilium daemon configuration, health, and cluster management

GET
/healthz
Cilium Get daemon health status
getDaemonHealth 1 param → 200500
GET
/config
Cilium Get daemon configuration
getDaemonConfig → 200500
PATCH
/config
Cilium Modify daemon configuration
patchDaemonConfig body → 200400500
GET
/cluster/nodes
Cilium List cluster nodes
getClusterNodes 1 param → 200500
GET
/debuginfo
Cilium Get debugging information
getDebugInfo → 200500
GET
/map
Cilium List BPF maps
getBPFMaps → 200500
GET
/node/ids
Cilium Get node IDs
getNodeIDs → 200500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are StatusResponse (9 properties), EndpointSpec (6 properties), EndpointStatus (5 properties), EndpointPolicyStatus (4 properties). Each schema is shown below with its type and property counts.

DaemonConfigurationStatus
object
Current effective configuration of the Cilium daemon.
2 properties
StatusResponse
object
Overall health and status of the Cilium daemon, including connectivity to external dependencies and subsystem health.
9 properties
BPFMapEntry
object
A single key-value entry in a BPF map.
3 properties
BPFMap
object
Information about a BPF map used by the Cilium datapath.
2 properties
ClusterNodeStatus
object
Cluster-wide node status and membership information.
2 properties
DaemonConfigurationSpec
object
Mutable configuration options for the Cilium daemon.
2 properties
NodeElement
object
Information about a single cluster node.
4 properties
AddressPair
object
IPv4 and IPv6 address pair for an endpoint.
2 properties
ControllerStatus
object
Status of a single Cilium background controller.
2 properties
Identity
object
A Cilium security identity, derived from the set of labels associated with a workload and used for policy enforcement decisions.
3 properties
NodeID
object
Mapping of a node name to its numeric datapath ID.
3 properties
Error
string
Human-readable error message.
KubeProxyReplacementStatus
object
Status of the kube-proxy replacement functionality.
1 property
MonitorStatus
object
Status of the Cilium node monitor.
3 properties
K8sStatus
object
Status of Kubernetes API server connectivity and version.
3 properties
DebugInfo
object
Comprehensive debugging information about the Cilium daemon.
4 properties
EndpointPolicyStatus
object
Policy enforcement status for an endpoint.
4 properties
DaemonConfiguration
object
Current runtime configuration of the Cilium daemon.
2 properties
EndpointPolicy
object
Desired or realized policy for an endpoint.
4 properties
EndpointStatus
object
Current status of an endpoint.
5 properties
ClusterStatus
object
Status of the Cilium cluster mesh connectivity.
2 properties
NodeAddress
object
Network address information for a cluster node.
2 properties
NodeStatus
object
Connectivity and health status of a single cluster node.
3 properties
EndpointSpec
object
Desired configuration for an endpoint.
6 properties
IPAMStatus
object
Current IPAM pool usage and allocation statistics.
2 properties
ControllerStatuses
object
Map of controller names to their current status.
Endpoint
object
A Cilium-managed network endpoint, typically corresponding to a Kubernetes pod or container with associated identity and policy state.
3 properties
Status
object
Health status of a single Cilium subsystem or dependency.
2 properties
EndpointHealth
object
Health status of an endpoint's BPF programs and policy.
4 properties
EndpointNetworking
object
Network addressing information for an endpoint.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cilium-daemon-api-openapi.yml Raw ↑

Other APIs Cilium publishes across the network.

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