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

Apply policies to all HTTP and HTTPS listeners defined on a Gateway. Configure listener-level settings that affect all traffic passing through the specified listeners.

Kgateway HTTPListenerPolicy 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 HTTPListenerPolicy. 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 4 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 4 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 HTTPListenerPolicy 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.

HTTPListenerPolicy 5

Apply policies to all HTTP and HTTPS listeners defined on a Gateway. Configure listener-level settings that affect all traffic passing through the specified listeners.

GET
/namespaces/{namespace}/httplistenerpolicies
Kgateway List HTTPListenerPolicy resources
listHTTPListenerPolicies 4 params → 200401
POST
/namespaces/{namespace}/httplistenerpolicies
Kgateway Create an HTTPListenerPolicy
createHTTPListenerPolicy 1 param body → 201401409
GET
/namespaces/{namespace}/httplistenerpolicies/{name}
Kgateway Get an HTTPListenerPolicy
getHTTPListenerPolicy 2 params → 200401404
PUT
/namespaces/{namespace}/httplistenerpolicies/{name}
Kgateway Replace an HTTPListenerPolicy
replaceHTTPListenerPolicy 2 params body → 200401404
DELETE
/namespaces/{namespace}/httplistenerpolicies/{name}
Kgateway Delete an HTTPListenerPolicy
deleteHTTPListenerPolicy 2 params → 200401404

Schemas 4

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

ObjectMeta
object
Standard Kubernetes object metadata.
6 properties
PolicyTargetRef
object
Reference to a target resource for policy attachment.
5 properties 2 required
HTTPListenerPolicy
object
HTTPListenerPolicy applies policies to all HTTP and HTTPS listeners on a Gateway.
5 properties
HTTPListenerPolicyList
object
List of HTTPListenerPolicy resources.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kgateway-httplistenerpolicy-api-openapi.yml Raw ↑

Other APIs Kgateway publishes across the network.

Kgateway AIBackend API
Kgateway Backend API
Kgateway DirectResponse API
Kgateway GatewayExtension API
Kgateway GatewayParameters API
Kgateway TrafficPolicy API