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

The policy API from Isovalent — 10 operation(s) for policy.

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

This API exposes 11 operations across 10 paths, and defines 15 schemas. It is described by OpenAPI 2.0, at version v1beta1.

Requests are made against the base URL unix:///var/run/cilium/cilium.sock.

11 operations 10 paths 15 schemas 1 DELETE10 GET

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 11

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

policy 11
GET
/identity
Retrieves a list of identities that have metadata matching the provided parameters.
1 param → 200404520521
GET
/identity/{id}
Retrieve identity
1 param → 200400404520521
GET
/identity/endpoints
Retrieve identities which are being used by local endpoints
→ 200404
GET
/policydeprecated
Retrieve entire policy tree
→ 200404
GET
/policy/selectors
See what selectors match which identities
→ 200
GET
/policy/subject-selectors
See what subject selectors match which identities on the local node
→ 200
GET
/fqdn/cache
Retrieves the list of DNS lookups intercepted from all endpoints.
3 params → 200400404
DELETE
/fqdn/cache
Deletes matching DNS lookups from the policy-generation cache.
1 param → 200403400
GET
/fqdn/cache/{id}
Retrieves the list of DNS lookups intercepted from an endpoint.
4 params → 200400404
GET
/fqdn/names
List internal DNS selector representations
→ 200400
GET
/ip
Lists information about known IP addresses
2 params → 200400404

Schemas 15

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

SelectorEntry
object
Mapping of FQDNSelector to corresponding regular expression
2 properties
DNSLookup
object
An IP - DNS mapping, with metadata
7 properties
Policy
object
Policy definition Deprecated, will be removed in v1.19.
2 properties
IPListEntry
object
IP entry with metadata
5 properties 2 required
Identity
object
Security identity
3 properties
Labels
array
Set of labels
SelectorCache
array
cache of which identities match selectors in the policy repository
LabelArrayList
array
LabelArrayList is an array of LabelArrays forming a set
SelectorIdentityMapping
object
mapping of selector to identities which match it
4 properties
IdentityEndpoints
object
Security identities owned by endpoints on the local node
2 properties
Label
object
Label is Cilium's representation of a label
3 properties
LabelArray
array
LabelArray is an array of labels forming a set
NameManager
object
Internal state about DNS names in relation to policy subsystem
2 properties
Error
string
IPListEntryMetadata
object
Additional metadata assigned to an IP list entry
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

isovalent-policy-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 ipam API
Isovalent prefilter API
Isovalent service API