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

GRPCRoute resources defining gRPC routing rules from Gateway listeners to backend services with service and method name matching.

Kubernetes Services GRPCRoute 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 GRPCRoute. 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 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.

2 operations 1 paths 5 schemas 1 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 GRPCRoute 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 POST. Each is listed below with its method, path, parameters, and response codes.

GRPCRoute 2

GRPCRoute resources defining gRPC routing rules from Gateway listeners to backend services with service and method name matching.

GET
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/grpcroutes
Kubernetes Services List GRPCRoutes in a namespace
listNamespacedGRPCRoutes 4 params → 200401
POST
/apis/gateway.networking.k8s.io/v1/namespaces/{namespace}/grpcroutes
Kubernetes Services Create a GRPCRoute
createNamespacedGRPCRoute 1 param body → 201400401

Schemas 5

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

GRPCRouteList
object
A list of GRPCRoute resources.
4 properties 1 required
ObjectMeta
object
Standard Kubernetes object metadata.
7 properties
Status
object
Error or result status.
4 properties
GRPCRoute
object
A GRPCRoute defines gRPC routing rules from Gateway listeners to backend services, matching on gRPC service and method names for targeted traffic distribution.
4 properties
ListMeta
object
Metadata for list responses.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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