Sign in
endpoint

Modify existing endpoint

Applies the endpoint change request to an existing endpoint

patch/endpoint/{id}

Path parameters

idstring required

String describing an endpoint with the format [prefix:]id. If no prefix is specified, a prefix of cilium-local: is assumed. Not all endpoints will be addressable by all endpoint ID prefixes with the exception of the local Cilium UUID which is assigned to all endpoints.

Supported endpoint id prefixes:

  • cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595
  • cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343
  • cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0
  • container-id: Container runtime ID, e.g. container-id:22222 (deprecated, may not be unique)
  • container-name: Container name, e.g. container-name:foobar (deprecated, may not be unique)
  • pod-name: pod name for this container if K8s is enabled, e.g. pod-name:default:foobar (deprecated, may not be unique)
  • cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1
  • docker-endpoint: Docker libnetwork endpoint ID, e.g. docker-endpoint:4444

Request body

idinteger

Local endpoint ID

container-idstring

ID assigned by container runtime

container-namestring

Name assigned to container

container-netns-pathstring

Path of Container Netns

docker-endpoint-idstring

Docker endpoint ID

labelsstring[]

Set of labels

docker-network-idstring

Docker network ID

interface-namestring

Name of network device in host netns

interface-indexinteger

Index of network device in host netns

parent-interface-indexinteger

Index of network device from which an IP was used as endpoint IP. Only relevant for ENI environments.

container-interface-namestring

Name of network device in container netns

state'waiting-for-identity' | 'not-ready' | 'waiting-to-regenerate' | 'regenerating' | 'restoring' | 'ready' | 'disconnecting' | 'disconnected' | 'invalid' required

State of endpoint

macstring

MAC address

host-macstring

MAC address

k8s-pod-namestring

Kubernetes pod name

k8s-namespacestring

Kubernetes namespace name

k8s-uidstring

Kubernetes pod UID

datapath-map-idinteger

ID of datapath tail call map

policy-enabledboolean

Whether policy enforcement is enabled or not

pidinteger

Process ID of the workload belonging to this endpoint

sync-build-endpointboolean

Whether to build an endpoint synchronously

disable-legacy-identifiersboolean

Disables lookup using legacy endpoint identifiers (container name, container id, pod name) for this endpoint

netns-cookiestring

Network namespace cookie

{"stackTrail":"components:schemas:EndpointChangeRequest:properties:properties","oasType":"schema","type":"unknown","description":"Properties is used to store information about the endpoint at creation. Useful for tests."}

Response

Success

Changes