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

The Service API from Cilium — 2 operation(s) for service.

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

Tagged areas include Service. 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 2 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 2 paths 7 schemas 1 DELETE2 GET1 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
Terms of Service
Resource Areas
1

Paths & Operations 4

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

Service 4
GET
/service
Cilium List services
listServices → 200500
GET
/service/{id}
Cilium Get service by ID
getService 1 param → 200404500
PUT
/service/{id}
Cilium Create or update service
putService 1 param body → 200201400500
DELETE
/service/{id}
Cilium Delete service
deleteService 1 param → 200404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ServiceSpecFlags (6 properties), BackendAddress (5 properties), FrontendAddress (4 properties), ServiceSpec (4 properties). Each schema is shown below with its type and property counts.

ServiceSpecFlags
object
Feature flags for a service.
6 properties
BackendAddress
object
A single backend endpoint for a load balancer service.
5 properties
ServiceSpec
object
Specification for a Cilium service.
4 properties
Service
object
A Cilium-managed load balancer service with frontend and backends.
2 properties
ServiceStatus
object
Realized status of a Cilium service.
1 property
FrontendAddress
object
Frontend VIP address and port for a service.
4 properties
Error
string
Human-readable error message.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cilium-service-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 IPAM API
Cilium Lrp API
Cilium Policy API
Cilium Prefilter API