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

Kubernetes Services EndpointSlices API

EndpointSlice resources tracking IP addresses, ports, and readiness of pods backing a Service, with topology-aware routing support.

Kubernetes Services EndpointSlices API is one of 13 APIs that Kubernetes Services publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 1 JSON Schema definition.

Tagged areas include EndpointSlices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, an AsyncAPI specification, and 1 JSON Schema.

This API exposes 7 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version v1.32.0.

Requests are made against a single base URL, https://kubernetes.default.svc.

7 operations 3 paths 9 schemas 1 DELETE3 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1.32.0
Server
https://kubernetes.default.svc
Authentication
HTTP Bearer, Mutual TLS
Terms of Service
Resource Areas
1

Authentication & Security 2

Kubernetes Services EndpointSlices API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It requires mutual TLS (clientCertificate). By default, every request must be authenticated.

  • bearerAuth — Kubernetes service account or user bearer token.
  • clientCertificate — Client TLS certificate signed by the cluster CA.

Paths & Operations 7

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

EndpointSlices 7

EndpointSlice resources tracking IP addresses, ports, and readiness of pods backing a Service, with topology-aware routing support.

GET
/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
Kubernetes Services List EndpointSlices in a namespace
listNamespacedEndpointSlices 6 params → 200401
POST
/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
Kubernetes Services Create an EndpointSlice
createNamespacedEndpointSlice 2 params body → 201400401
GET
/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
Kubernetes Services Get an EndpointSlice
getNamespacedEndpointSlice 2 params → 200401404
PUT
/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
Kubernetes Services Replace an EndpointSlice
replaceNamespacedEndpointSlice 3 params body → 200400401404
PATCH
/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
Kubernetes Services Patch an EndpointSlice
patchNamespacedEndpointSlice 2 params body → 200401404
DELETE
/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
Kubernetes Services Delete an EndpointSlice
deleteNamespacedEndpointSlice 2 params → 200401404
GET
/apis/discovery.k8s.io/v1/endpointslices
Kubernetes Services List EndpointSlices across all namespaces
listEndpointSlicesAllNamespaces 4 params → 200401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Endpoint (7 properties), ObjectMeta (7 properties), EndpointSlice (6 properties), Status (4 properties). Each schema is shown below with its type and property counts.

EndpointPort
object
A network port definition shared by all endpoints in the slice. An EndpointSlice may have up to 100 ports.
4 properties
EndpointSliceList
object
A list of EndpointSlice objects.
4 properties 1 required
EndpointSlice
object
An EndpointSlice represents a subset of the endpoints that implement a Service. For a given Service, multiple EndpointSlices may exist, and together they repre…
6 properties 2 required
EndpointHints
object
Routing hints that guide topology-aware routing decisions, directing clients to geographically or logically proximate endpoints.
2 properties
EndpointConditions
object
Conditions describing the current state of an endpoint, used by consumers to determine whether the endpoint should receive traffic.
3 properties
ObjectMeta
object
Standard Kubernetes object metadata.
7 properties
Endpoint
object
A single network endpoint representing a pod IP address, its readiness conditions, and optional topology information for advanced routing.
7 properties 1 required
Status
object
Error or result status.
4 properties
ListMeta
object
Metadata for list responses.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubernetes-services-endpointslices-api-openapi.yml Raw ↑

Other APIs Kubernetes Services publishes across the network.

Kubernetes DNS for Services and Pods
Kubernetes Services Gateway API
Kubernetes Services GatewayClass API
Kubernetes Services GRPCRoute API
Kubernetes Services HTTPRoute API
Kubernetes Services Ingress API
Kubernetes Services IngressClass API
Kubernetes Services IngressStatus API
Kubernetes Services Namespaces API
Kubernetes Services NetworkPolicy API
Kubernetes Services Services API
Kubernetes Services ServiceStatus API