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

Configure Gateways to directly respond to incoming requests with a custom HTTP response code and body without forwarding to a backend service.

Kgateway DirectResponse 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 DirectResponse. 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 DirectResponse 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.

DirectResponse 5

Configure Gateways to directly respond to incoming requests with a custom HTTP response code and body without forwarding to a backend service.

GET
/namespaces/{namespace}/directresponses
Kgateway List DirectResponse resources
listDirectResponses 4 params → 200401
POST
/namespaces/{namespace}/directresponses
Kgateway Create a DirectResponse
createDirectResponse 1 param body → 201401409
GET
/namespaces/{namespace}/directresponses/{name}
Kgateway Get a DirectResponse
getDirectResponse 2 params → 200401404
PUT
/namespaces/{namespace}/directresponses/{name}
Kgateway Replace a DirectResponse
replaceDirectResponse 2 params body → 200401404
DELETE
/namespaces/{namespace}/directresponses/{name}
Kgateway Delete a DirectResponse
deleteDirectResponse 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), DirectResponse (5 properties), DirectResponseList (4 properties). Each schema is shown below with its type and property counts.

DirectResponse
object
DirectResponse configures a Gateway to directly respond to incoming requests with a custom HTTP response code and body.
5 properties
ObjectMeta
object
Standard Kubernetes object metadata.
6 properties
DirectResponseList
object
List of DirectResponse resources.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kgateway-directresponse-api-openapi.yml Raw ↑

Other APIs Kgateway publishes across the network.

Kgateway AIBackend API
Kgateway Backend API
Kgateway GatewayExtension API
Kgateway GatewayParameters API
Kgateway HTTPListenerPolicy API
Kgateway TrafficPolicy API