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

Network policy, security identities, and FQDN/DNS policy

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

Tagged areas include Policy. 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 5 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 5 schemas 1 DELETE6 GET

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 — 1 DELETE, 6 GET. Each is listed below with its method, path, parameters, and response codes.

Policy 7

Network policy, security identities, and FQDN/DNS policy

GET
/identity
Cilium List security identities
listIdentities 1 param → 200400500
GET
/identity/{id}
Cilium Get identity by ID
getIdentity 1 param → 200400404500
GET
/identity/endpoints
Cilium List local endpoint identities
getLocalEndpointIdentities → 200500
GET
/policy/selectors
Cilium Get policy selectors
getPolicySelectors → 200500
GET
/fqdn/cache
Cilium Get FQDN DNS cache
getFQDNCache 3 params → 200400500
DELETE
/fqdn/cache
Cilium Clear FQDN DNS cache
deleteFQDNCache 1 param → 200400500
GET
/fqdn/names
Cilium Get FQDN selector names
getFQDNNames → 200400500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are DNSLookup (5 properties), Identity (3 properties), SelectorCache (3 properties), NameManager (1 property). Each schema is shown below with its type and property counts.

SelectorCache
object
A policy selector and the identities it currently matches.
3 properties
NameManager
object
FQDN name manager state including all tracked DNS names.
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
Error
string
Human-readable error message.
DNSLookup
object
A DNS lookup entry in the FQDN cache.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cilium-policy-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 Prefilter API
Cilium Service API