Kubernetes Services Ingress 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 Ingress. 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 11 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 operations3 paths11 schemas1 DELETE3 GET1 PATCH1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Kubernetes Services Ingress 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.
Ingress 7
Ingress resources defining HTTP and HTTPS routing rules from external traffic to cluster services, with TLS termination support.
Kubernetes Services List Ingresses across all namespaces
listIngressesAllNamespaces4 params→ 200401
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ObjectMeta (7 properties), Ingress (5 properties), IngressList (4 properties), Status (4 properties). Each schema is shown below with its type and property counts.
Ingress
object
An Ingress manages external access to the services in a cluster, typically HTTP/HTTPS. It provides load balancing, SSL termination, and name-based virtual host…
5 properties
IngressTLS
object
TLS configuration for an Ingress, specifying a Secret containing the certificate and key for terminating HTTPS connections on port 443.
2 properties
IngressStatus
object
Most recently observed status of an Ingress, reporting the load balancer IPs or hostnames assigned by the ingress controller.
1 property
IngressSpec
object
Specification of the desired behavior of an Ingress, including the routing rules, TLS configuration, default backend, and reference to the ingress controller v…
4 properties
HTTPIngressPath
object
A mapping of an HTTP path to a backend service. Used within Ingress rules to route specific paths to different services.
3 properties2 required
IngressRule
object
A host-based routing rule mapping HTTP requests to backend services based on hostname and path prefix matching.
2 properties
IngressBackend
object
Reference to the backend service or resource that an Ingress routing rule should forward traffic to.
2 properties
ObjectMeta
object
Standard Kubernetes object metadata.
7 properties
Status
object
Error or result status returned by the API.
4 properties
IngressList
object
A list of Ingress objects.
4 properties1 required
ListMeta
object
Metadata for list responses.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
