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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Cilium

Cilium Endpoint API

Endpoint lifecycle management, configuration, and status

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

12 operations 6 paths 16 schemas 2 DELETE6 GET3 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1beta1
Base URL
https://localhost/v1
Contact
Cilium Community
Terms of Service
View terms
Resource Areas
1

Paths & Operations 12

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

Endpoint 12

Endpoint lifecycle management, configuration, and status

GET
/endpoint
Cilium List endpoints
listEndpoints 1 param → 200400500
DELETE
/endpoint
Cilium Delete endpoints by label selector
deleteEndpoints 1 param → 200400404500
GET
/endpoint/{id}
Cilium Get endpoint by ID
getEndpoint 1 param → 200400404500
PUT
/endpoint/{id}
Cilium Create or replace endpoint
putEndpoint 1 param body → 201400409500
PATCH
/endpoint/{id}
Cilium Modify endpoint
patchEndpoint 1 param body → 200400404500
DELETE
/endpoint/{id}
Cilium Delete endpoint
deleteEndpoint 1 param → 200400404500
GET
/endpoint/{id}/config
Cilium Get endpoint configuration
getEndpointConfig 1 param → 200400404500
PATCH
/endpoint/{id}/config
Cilium Modify endpoint configuration
patchEndpointConfig 1 param body → 200400404500
GET
/endpoint/{id}/labels
Cilium Get endpoint labels
getEndpointLabels 1 param → 200404500
PATCH
/endpoint/{id}/labels
Cilium Modify endpoint labels
patchEndpointLabels 1 param body → 200400404500
GET
/endpoint/{id}/log
Cilium Get endpoint status log
getEndpointLog 1 param → 200404500
GET
/endpoint/{id}/healthz
Cilium Get endpoint health
getEndpointHealth 1 param → 200400404500

Schemas 16

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

AddressPair
object
IPv4 and IPv6 address pair for an endpoint.
2 properties
LabelConfigurationStatus
object
Current label state of an endpoint.
4 properties
EndpointSpec
object
Desired configuration for an endpoint.
6 properties
LabelConfiguration
object
Full label configuration for an endpoint.
1 property
EndpointStatusChange
object
A single entry in an endpoint's status change log.
4 properties
Endpoint
object
A Cilium-managed network endpoint, typically corresponding to a Kubernetes pod or container with associated identity and policy state.
3 properties
EndpointChangeRequest
object
Request payload for creating or modifying an endpoint.
7 properties
EndpointNetworking
object
Network addressing information for an endpoint.
2 properties
EndpointHealth
object
Health status of an endpoint's BPF programs and policy.
4 properties
EndpointConfigurationSpec
object
Configuration options for a specific endpoint.
1 property
Identity
object
A Cilium security identity, derived from the set of labels associated with a workload and used for policy enforcement decisions.
3 properties
EndpointPolicyStatus
object
Policy enforcement status for an endpoint.
4 properties
LabelConfigurationSpec
object
Desired label configuration for an endpoint.
1 property
Error
string
Human-readable error message.
EndpointPolicy
object
Desired or realized policy for an endpoint.
4 properties
EndpointStatus
object
Current status of an endpoint.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cilium-endpoint-api-openapi.yml Raw ↑

Other APIs Cilium publishes across the network.

Hubble API
AE Profile APIs.io
Tetragon API
AE Profile APIs.io
Hubble Relay API
AE Profile APIs.io
Cilium BGP API
AE Profile APIs.io
Cilium Daemon API
AE Profile APIs.io
Cilium IPAM API
AE Profile APIs.io
Cilium Lrp API
AE Profile APIs.io
Cilium Policy API
AE Profile APIs.io
Cilium Prefilter API
AE Profile APIs.io
Cilium Service API
AE Profile APIs.io
#Endpoint
← Back to C APIs
API Details
ID
cilium:cilium-endpoint-api
Base URL
https://localhost/v1
Docs
https://docs.cilium.io/en/stable/api/
Provider
Cilium
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network