Isovalent endpoint API is one of 10 APIs that Isovalent 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 and API documentation.
This API exposes
12 operations
across 6 paths,
and defines 37 schemas.
It is described by OpenAPI 2.0, at version v1beta1.
Requests are made against the base URL unix:///var/run/cilium/cilium.sock.
12 operations6 paths37 schemas2 DELETE6 GET3 PATCH1 PUT
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 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
GET
/endpoint/{id}
Get endpoint by endpoint ID
1 param→ 200400404429
PUT
/endpoint/{id}
Create endpoint
2 params→ 201400403409500429503
PATCH
/endpoint/{id}deprecated
Modify existing endpoint
2 params→ 200400403404500429503
DELETE
/endpoint/{id}
Delete endpoint
1 param→ 200206400403404429503
GET
/endpoint
Retrieves a list of endpoints that have metadata matching the provided parameters.
1 param→ 200404429
DELETE
/endpoint
Deletes a list of endpoints
1 param→ 200206400404429503
GET
/endpoint/{id}/config
Retrieve endpoint configuration
1 param→ 200404429
PATCH
/endpoint/{id}/config
Modify mutable endpoint configuration
2 params→ 200400403404500429503
GET
/endpoint/{id}/labels
Retrieves the list of labels associated with an endpoint.
1 param→ 200404429
PATCH
/endpoint/{id}/labels
Set label configuration of endpoint
2 params→ 200403404500429503
GET
/endpoint/{id}/log
Retrieves the status logs associated with this endpoint.
1 param→ 200400404429
GET
/endpoint/{id}/healthz
Retrieves the status logs associated with this endpoint.
1 param→ 200400404429
Schemas 37
The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are EndpointChangeRequest (23 properties), EndpointStatus (11 properties), EndpointPolicy (10 properties), EndpointIdentifiers (8 properties). Each schema is shown below with its type and property counts.
EndpointPolicy
object
Policy information of an endpoint
10 properties
EndpointIdentifiers
object
Unique identifiers for this endpoint from outside cilium +deepequal-gen=true
8 properties
LabelConfigurationSpec
object
User desired Label configuration of an endpoint
1 property
EndpointPolicyEnabled
string
Whether policy enforcement is enabled (ingress, egress, both or none)
AddressPair
object
Addressing information of an endpoint
6 properties
RequestResponseStatistics
object
Statistics of a proxy redirect +k8s:deepcopy-gen=true
2 properties
PolicyRule
object
A policy rule including the rule labels it derives from
3 properties
NodeAddressing
object
Addressing information of a node for all address families +k8s:deepcopy-gen=true
2 properties
EndpointConfigurationSpec
object
An endpoint's configuration
2 properties
EndpointStatusLog
array
Status log of endpoint
Identity
object
Security identity
3 properties
EndpointHealth
object
Health of the endpoint +deepequal-gen=true
4 properties
NodeAddressingElement
object
Addressing information
4 properties
ConfigurationMap
object
Map of configuration key/value pairs.
LabelConfigurationStatus
object
Labels and label configuration of an endpoint
4 properties
Labels
array
Set of labels
EndpointPolicyStatus
object
Policy information of an endpoint
4 properties
NamedPorts
array
List of named Layer 4 port and protocol pairs which will be used in Network Policy specs. +deepequal-gen=true +k8s:deepcopy-gen=true
CIDRPolicy
object
CIDR endpoint policy
2 properties
LabelConfiguration
object
Label configuration of an endpoint
2 properties
EndpointHealthStatus
string
A common set of statuses for endpoint health OK = All components operational Bootstrap = This component is being created Pending = A change is being processed…
EndpointNetworking
object
Unique identifiers for this endpoint from outside cilium
7 properties
EndpointDatapathConfiguration
object
Datapath configuration to be used for the endpoint
6 properties
EndpointStatus
object
The current state and configuration of the endpoint, its policy & datapath, and subcomponents
11 properties1 required
ControllerStatus
object
Status of a controller +k8s:deepcopy-gen=true
4 properties
EndpointState
string
State of endpoint
ProxyStatistics
object
Statistics of a set of proxy redirects for an endpoint +k8s:deepcopy-gen=true
5 properties
EndpointChangeRequest
object
Structure which contains the mutable elements of an Endpoint.
23 properties1 required
EndpointBatchDeleteRequest
object
Properties selecting a batch of endpoints to delete.
1 property
Port
object
Layer 4 port / protocol pair +deepequal-gen=true
3 properties
Error
string
MessageForwardingStatistics
object
Statistics of a message forwarding entity
4 properties
Endpoint
object
An endpoint is a namespaced network interface to which cilium applies policies
3 properties
L4Policy
object
L4 endpoint policy
2 properties
EndpointConfigurationStatus
object
An endpoint's configuration
3 properties
ControllerStatuses
array
Collection of controller statuses
EndpointStatusChange
object
Indication of a change of status +deepequal-gen=true
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
