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

Kgateway Backend API

Define routable backends such as AI providers (OpenAI, Azure, Gemini), AWS Lambda functions, or static servers for use by Gateways. Reference Backend resources in HTTPRoute to route traffic to external services.

Kgateway Backend API is one of 7 APIs that Kgateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Backend. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 7 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.1.0.

Requests are made against a single base URL, https://{kubernetes-api-server}/apis/gateway.kgateway.dev/v1alpha1.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.1.0
Base URL
https://kubernetes.default.svc/apis/gateway.kgateway.dev/v1alpha1
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Kgateway Backend API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Kubernetes API bearer token authentication. Use a service account token or kubeconfig token.

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.

Backend 5

Define routable backends such as AI providers (OpenAI, Azure, Gemini), AWS Lambda functions, or static servers for use by Gateways. Reference Backend resources in HTTPRoute to rou…

GET
/namespaces/{namespace}/backends
Kgateway List Backend resources
listBackends 4 params → 200401
POST
/namespaces/{namespace}/backends
Kgateway Create a Backend
createBackend 1 param body → 201401409
GET
/namespaces/{namespace}/backends/{name}
Kgateway Get a Backend
getBackend 2 params → 200401404
PUT
/namespaces/{namespace}/backends/{name}
Kgateway Replace a Backend
replaceBackend 2 params body → 200401404
DELETE
/namespaces/{namespace}/backends/{name}
Kgateway Delete a Backend
deleteBackend 2 params → 200401404

Schemas 3

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

Backend
object
Backend defines a routable backend such as an AI provider, AWS Lambda function, or static server for use by Gateways.
5 properties
ObjectMeta
object
Standard Kubernetes object metadata.
6 properties
BackendList
object
List of Backend resources.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kgateway-backend-api-openapi.yml Raw ↑

Other APIs Kgateway publishes across the network.

Kgateway AIBackend API
Kgateway DirectResponse API
Kgateway GatewayExtension API
Kgateway GatewayParameters API
Kgateway HTTPListenerPolicy API
Kgateway TrafficPolicy API