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

Status subresource for Ingress objects, reporting load balancer IP or hostname assignments from the ingress controller.

Kubernetes Services IngressStatus 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 IngressStatus. 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 2 operations across 1 path, 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.

2 operations 1 paths 9 schemas 1 GET1 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 IngressStatus 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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

IngressStatus 2

Status subresource for Ingress objects, reporting load balancer IP or hostname assignments from the ingress controller.

GET
/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
Kubernetes Services Get Ingress status
getNamespacedIngressStatus 2 params → 200401404
PUT
/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
Kubernetes Services Replace Ingress status
replaceNamespacedIngressStatus 2 params body → 200401404

Schemas 9

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

IngressTLS
object
TLS configuration for an Ingress, specifying a Secret containing the certificate and key for terminating HTTPS connections on port 443.
2 properties
ObjectMeta
object
Standard Kubernetes object metadata.
7 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
IngressRule
object
A host-based routing rule mapping HTTP requests to backend services based on hostname and path prefix matching.
2 properties
Status
object
Error or result status returned by the API.
4 properties
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
IngressBackend
object
Reference to the backend service or resource that an Ingress routing rule should forward traffic to.
2 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 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Kubernetes Services publishes across the network.

Kubernetes DNS for Services and Pods
Kubernetes Services EndpointSlices API
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 Namespaces API
Kubernetes Services NetworkPolicy API
Kubernetes Services Services API
Kubernetes Services ServiceStatus API