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

GatewayClass resources defining a class of gateway implementations. Cluster-scoped resources that link to a specific ingress or mesh controller.

Kubernetes Services GatewayClass 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 GatewayClass. 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 6 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 6 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 GatewayClass 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.

GatewayClass 4

GatewayClass resources defining a class of gateway implementations. Cluster-scoped resources that link to a specific ingress or mesh controller.

GET
/apis/gateway.networking.k8s.io/v1/gatewayclasses
Kubernetes Services List GatewayClasses
listGatewayClasses 3 params → 200401
POST
/apis/gateway.networking.k8s.io/v1/gatewayclasses
Kubernetes Services Create a GatewayClass
createGatewayClass body → 201400401
GET
/apis/gateway.networking.k8s.io/v1/gatewayclasses/{name}
Kubernetes Services Get a GatewayClass
getGatewayClass 1 param → 200401404
DELETE
/apis/gateway.networking.k8s.io/v1/gatewayclasses/{name}
Kubernetes Services Delete a GatewayClass
deleteGatewayClass 1 param → 200401404

Schemas 6

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

GatewayClass
object
A GatewayClass is a cluster-scoped resource that defines a class of gateway implementations, linking to a specific gateway controller via the controllerName fi…
5 properties
ObjectMeta
object
Standard Kubernetes object metadata.
7 properties
Status
object
Error or result status.
4 properties
Condition
object
A condition expressing an aspect of current resource state.
5 properties 2 required
ListMeta
object
Metadata for list responses.
3 properties
GatewayClassList
object
A list of GatewayClass resources.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubernetes-services-gatewayclass-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 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