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

HTTPRoute resources defining HTTP and HTTPS routing rules from Gateway listeners to backend services with support for path, header, and query parameter matching.

Kubernetes Services HTTPRoute 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 HTTPRoute. 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 8 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 8 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 HTTPRoute 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.

HTTPRoute 5

HTTPRoute resources defining HTTP and HTTPS routing rules from Gateway listeners to backend services with support for path, header, and query parameter matching.

GET
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/httproutes
Kubernetes Services List HTTPRoutes in a namespace
listNamespacedHTTPRoutes 4 params → 200401
POST
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/httproutes
Kubernetes Services Create an HTTPRoute
createNamespacedHTTPRoute 2 params body → 201400401
GET
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/httproutes/{name}
Kubernetes Services Get an HTTPRoute
getNamespacedHTTPRoute 2 params → 200401404
PUT
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/httproutes/{name}
Kubernetes Services Replace an HTTPRoute
replaceNamespacedHTTPRoute 2 params body → 200401404
DELETE
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/httproutes/{name}
Kubernetes Services Delete an HTTPRoute
deleteNamespacedHTTPRoute 2 params → 200401404

Schemas 8

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

ObjectMeta
object
Standard Kubernetes object metadata.
7 properties
HTTPRouteMatch
object
Conditions for matching an incoming HTTP request. Multiple matches within a rule are OR'd; conditions within a match are AND'd.
4 properties
HTTPBackendRef
object
Reference to a backend service in an HTTPRoute rule, with an optional traffic weight for proportional routing.
4 properties 2 required
Status
object
Error or result status.
4 properties
Condition
object
A condition expressing an aspect of current resource state.
5 properties 2 required
HTTPRouteList
object
A list of HTTPRoute resources.
4 properties 1 required
ListMeta
object
Metadata for list responses.
3 properties
HTTPRoute
object
An HTTPRoute defines HTTP routing rules from one or more Gateway listeners to backend services. Rules support rich matching on path, headers, query parameters,…
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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