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

Gateway resources instantiating traffic-handling infrastructure such as cloud load balancers or in-cluster proxies, with listeners for each protocol.

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

5 operations 2 paths 7 schemas 1 DELETE2 GET1 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 Gateway 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 5

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

Gateway 5

Gateway resources instantiating traffic-handling infrastructure such as cloud load balancers or in-cluster proxies, with listeners for each protocol.

GET
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/gateways
Kubernetes Services List Gateways in a namespace
listNamespacedGateways 4 params → 200401
POST
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/gateways
Kubernetes Services Create a Gateway
createNamespacedGateway 2 params body → 201400401
GET
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/gateways/{name}
Kubernetes Services Get a Gateway
getNamespacedGateway 2 params → 200401404
PUT
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/gateways/{name}
Kubernetes Services Replace a Gateway
replaceNamespacedGateway 2 params body → 200401404
DELETE
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/gateways/{name}
Kubernetes Services Delete a Gateway
deleteNamespacedGateway 2 params → 200401404

Schemas 7

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

GatewayListener
object
A listener on a Gateway defining the protocol, port, optional hostname, and which routes are allowed to attach.
6 properties 3 required
ObjectMeta
object
Standard Kubernetes object metadata.
7 properties
GatewayList
object
A list of Gateway resources.
4 properties 1 required
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
Gateway
object
A Gateway represents an instance of traffic-handling infrastructure, such as a cloud load balancer or in-cluster proxy. It listens on one or more ports and del…
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Kubernetes Services publishes across the network.

Kubernetes DNS for Services and Pods
Kubernetes Services EndpointSlices 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