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

IngressClass resources identifying which ingress controller should fulfill an Ingress resource.

Kubernetes Services IngressClass 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 IngressClass. 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 4 operations across 2 paths, and defines 5 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.

4 operations 2 paths 5 schemas 1 DELETE2 GET1 POST

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 IngressClass 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 4

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

IngressClass 4

IngressClass resources identifying which ingress controller should fulfill an Ingress resource.

GET
/apis/networking.k8s.io/v1/ingressclasses
Kubernetes Services List IngressClasses
listIngressClasses 3 params → 200401
POST
/apis/networking.k8s.io/v1/ingressclasses
Kubernetes Services Create an IngressClass
createIngressClass body → 201400401
GET
/apis/networking.k8s.io/v1/ingressclasses/{name}
Kubernetes Services Get an IngressClass
getIngressClass 1 param → 200401404
DELETE
/apis/networking.k8s.io/v1/ingressclasses/{name}
Kubernetes Services Delete an IngressClass
deleteIngressClass 1 param → 200401404

Schemas 5

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

ObjectMeta
object
Standard Kubernetes object metadata.
7 properties
IngressClass
object
An IngressClass is a cluster-scoped resource that represents an ingress controller implementation. Ingress objects reference an IngressClass by name to select…
4 properties
IngressClassList
object
A list of IngressClass resources.
4 properties 1 required
Status
object
Error or result status returned by the API.
4 properties
ListMeta
object
Metadata for list responses.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubernetes-services-ingressclass-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 IngressStatus API
Kubernetes Services Namespaces API
Kubernetes Services NetworkPolicy API
Kubernetes Services Services API
Kubernetes Services ServiceStatus API