AgentgatewayBackend

agentgateway.dev / v1alpha1

apiVersion: agentgateway.dev/v1alpha1 kind: AgentgatewayBackend metadata: name: example

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

Desired backend configuration.

a2a object

A2A backend.

host string required

Hostname or IP address of the A2A backend.

minLength: 1

maxLength: 256

port integer required

Port number of the A2A backend.

format: int32

minimum: 1

maximum: 65535

ai object

LLM backend.

groups []object

Groups in priority order, where each group defines a set of LLM providers. The priority determines the priority of the backend endpoints chosen. Note: provider names must be unique across all providers in all priority groups. Backend policies may target a specific provider by name using `targetRefs[].sectionName`. Example configuration with two priority groups: groups: - providers: - azureopenai: deploymentName: gpt-4o-mini apiVersion: 2024-02-15-preview endpoint: ai-gateway.openai.azure.com - providers: - azureopenai: deploymentName: gpt-4o-mini-2 apiVersion: 2024-02-15-preview endpoint: ai-gateway-2.openai.azure.com policies: auth: secretRef: name: azure-secret

minItems: 1

maxItems: 8

providers []object required

LLM providers within this group. Each provider is treated equally in terms of priority, with automatic weighting based on health.

minItems: 1

maxItems: 16

anthropic object

Anthropic provider settings.

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

azure object

Azure provider with resource-based configuration. Supports both Azure OpenAI and Azure AI Foundry resource types.

apiVersion string

The version of the Azure OpenAI API to use. If unset, defaults to `v1`.

minLength: 1

maxLength: 64

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

projectName string

The Foundry project name, required when `resourceType` is `Foundry`. Used to construct paths: /api/projects/{projectName}/openai/v1/...

minLength: 1

maxLength: 256

resourceName string required

The Azure resource name used to construct the endpoint host. For OpenAI: {resourceName}.openai.azure.com For Foundry: {resourceName}.services.ai.azure.com Note: when the Azure portal "Foundry legacy" template was used, the generated resource name may end in "-resource" (e.g. "myproject-resource"); that suffix is part of the resource name as the user configured it, not part of the hostname suffix agentgateway should append.

minLength: 1

maxLength: 256

resourceType string required

The type of Azure endpoint. Determines the host suffix.

enum: Foundry, OpenAI

azureopenai object

Azure OpenAI provider settings.

apiVersion string

The version of the Azure OpenAI API to use. For more information, see the [Azure OpenAI API version reference](https://learn.microsoft.com/en-us/azure/foundry/openai/reference). If unset, defaults to `v1`.

minLength: 1

maxLength: 64

deploymentName string

The name of the Azure OpenAI model deployment to use. For more information, see the [Azure OpenAI model docs](https://learn.microsoft.com/en-us/azure/foundry/foundry-models/concepts/models-sold-directly-by-azure?view=foundry-classic). This is required if `apiVersion` is not `v1`. For `v1`, the model can be set in the request.

minLength: 1

maxLength: 256

endpoint string required

The endpoint for the Azure OpenAI API to use, such as `my-endpoint.openai.azure.com`. If the scheme is included, it is stripped.

minLength: 1

maxLength: 256

bedrock object

Bedrock provider settings.

guardrail object

Guardrail policy to use for the backend. See <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html>. If not specified, the AWS Guardrail policy will not be used.

identifier string required

Identifier of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

version string required

Version of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

region string

AWS region to use for the backend. Defaults to `us-east-1` if not specified.

pattern: ^[a-z0-9-]+$

minLength: 1

maxLength: 63

custom object

Custom provider configures a non-managed or self-hosted LLM provider. Use this when the provider target and API formats should be declared explicitly instead of inferred from a managed provider such as OpenAI or Anthropic.

backendRef object

Kubernetes backend that serves this provider. `backendRef` may target only a namespace-local Service or InferencePool. If unset, host and port must be set on the parent provider.

group string

API group of the referenced resource. For example, `gateway.networking.k8s.io`. When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kind of the referenced resource. For example, `Service`. Defaults to "Service" when not specified.

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name of the referenced resource.

minLength: 1

maxLength: 253

port integer

Destination port number to use for this resource. Required when the referenced resource is a Kubernetes Service.

format: int32

minimum: 1

maximum: 65535

formats []object required

Provider-native API formats this provider supports.

minItems: 1

maxItems: 6

path string

Default upstream path override for this format. If unset, agentgateway uses the default path for the format.

minLength: 1

maxLength: 1024

type string required

Provider-native API format.

enum: AnthropicTokenCount, Completions, Embeddings, Messages, Realtime, Rerank, Responses

model string

Model name override, such as `gpt-oss`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

providerOverride string

Provider identity used for cost-catalog lookup and telemetry. Defaults to "custom" when unset.

minLength: 1

maxLength: 256

gemini object

Gemini provider settings.

model string

Model name override, such as `gemini-2.5-pro`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

host string

Hostname to send requests to. For custom providers without backendRef, host and port specify the target. For managed providers, host and port override the provider default.

minLength: 1

maxLength: 256

name string required

Name of the provider. Policies can target this provider by name.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

openai object

OpenAI provider settings.

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

moderation object

Inline moderation configuration to inject into OpenAI chat completions and responses requests. If unset, the OpenAI inline moderation parameter is not injected.

model string

The moderation model to use, such as `omni-moderation-latest`. Defaults to `omni-moderation-latest` if not specified.

minLength: 1

maxLength: 256

policy object

Policies to apply to request input and generated output.

input object

Policy for request input moderation.

mode string required

Mode controls whether moderation only returns scores or blocks flagged content.

enum: Block, Score

output object

Policy for generated output moderation.

mode string required

Mode controls whether moderation only returns scores or blocks flagged content.

enum: Block, Score

path string

URL path to use for LLM provider API requests. This is useful when you need to route requests to a different API endpoint while maintaining compatibility with the original provider's API structure. If not specified, the default path for the provider is used.

minLength: 1

maxLength: 1024

pathPrefix string

Overrides the default base path prefix, such as `/v1`, for upstream requests. Path translation for cross-format requests still applies using this prefix. Only supported for OpenAI and Anthropic providers.

minLength: 1

maxLength: 1024

policies object

Policies for communicating with this backend. Policies may also be set in `AgentgatewayPolicy`, or in the top-level `AgentgatewayBackend`. Policies are merged on a field-level basis, with order: `AgentgatewayPolicy` < `AgentgatewayBackend` < `AgentgatewayBackend` LLM provider (this field).

ai object

Settings for AI workloads. This is only applicable when connecting to a `Backend` of type `ai`.

defaults []object

Defaults to merge with user input fields. If the field is already set, the field in the request is used.

minItems: 1

maxItems: 64

field string required

Name of the field.

minLength: 1

maxLength: 256

value object required

Default value for the field. This can be any JSON data type.

finalTransformations []object

CEL transformations to compute and set fields in the request body. The expression result overwrites any existing value for that field. This has a higher priority than `overrides` if both are set for the same key. Those transformations are applied after the request is converted to the provider's format, so they can be used to set provider-specific fields.

minItems: 1

maxItems: 64

expression string required

CEL expression used to compute the field value.

minLength: 1

maxLength: 16384

field string required

Name of the field to set.

minLength: 1

maxLength: 256

modelAliases object

Maps friendly model names to actual provider model names. Example: `{"fast": "gpt-3.5-turbo", "smart": "gpt-4-turbo"}`. Note: This field is only applicable when using the agentgateway data plane.

overrides []object

Overrides to merge with user input fields. If the field is already set, the field is overwritten.

minItems: 1

maxItems: 64

field string required

Name of the field.

minLength: 1

maxLength: 256

value object required

Default value for the field. This can be any JSON data type.

prompt object

Enriches requests sent to the LLM provider by appending and prepending system prompts. This can be configured only for LLM providers that use the `CHAT` or `CHAT_STREAMING` API route type.

append []object

Messages to append to the prompt sent by the client.

content string required

String content of the message.

role string required

Role of the message. The available roles depend on the backend LLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.

prepend []object

Messages to prepend to the prompt sent by the client.

content string required

String content of the message.

role string required

Role of the message. The available roles depend on the backend LLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.

promptCaching object

Automatic prompt caching for supported providers, currently AWS Bedrock. Reduces API costs by caching static content like system prompts and tool definitions. Only applicable for Bedrock Claude 3+ and Nova models.

cacheMessageOffset integer

Shifts the message cache point further back in the conversation. 0 (default) places it at the second-to-last message. Higher values move it N additional messages towards the start, clamped to bounds.

minimum: 0

cacheMessages boolean

Enables caching for conversation messages. Caches all messages in the conversation for cost savings.

cacheSystem boolean

Enables caching for system prompts. Inserts a cache point after all system messages.

cacheTools boolean

Enables caching for tool definitions. Inserts a cache point after all tool specifications.

minTokens integer

Minimum estimated token count before caching is enabled. Uses rough heuristic (word count × 1.3) to estimate tokens. Bedrock requires at least 1,024 tokens for caching to be effective.

minimum: 0

promptGuard object

Guardrails for LLM requests and responses.

request []object

Prompt guards to apply to requests sent by the client.

minItems: 1

maxItems: 8

bedrockGuardrails object

AWS Bedrock Guardrails settings for prompt guarding.

action string

Action controls whether the guardrail's verdict is enforced or only observed. `Reject` (the default) enforces the guardrail: a blocked assessment rejects the request/response and an anonymized assessment masks the matched content. `Audit` runs the guardrail in observe mode: it is invoked and its assessment recorded (metrics + structured log), but the request/response is never blocked or masked.

enum: Audit, Reject

identifier string required

Identifier of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

policies object

Policies for communicating with AWS Bedrock Guardrails.

auth object

Settings for authenticating to AWS Bedrock Guardrails.

aws object

AWS authentication method for Bedrock Guardrails. Use `aws: {}` for default AWS SDK credential discovery.

assumeRole object

AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.

roleArn string required

AWS IAM role ARN to assume.

pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$

minLength: 1

sessionName string

SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.

pattern: ^[\w+=,.@-]{2,64}$

sessionNameExpression string

SessionNameExpression is a CEL expression evaluated against each request to produce the session name (RoleSessionName), for example `jwt.sub` or `request.headers["x-team"]`. If the expression does not produce a valid session name at request time, the request is rejected.

minLength: 1

maxLength: 16384

tags []object

Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.

maxItems: 50

expression string

CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.

minLength: 1

maxLength: 16384

key string required

Key is the tag key.

minLength: 1

maxLength: 128

value string

Value is a static tag value.

maxLength: 256

region string

AWS SigV4 signing region, for example `us-east-1`. Set this when the target AWS service is in a different region than the gateway. If unset, typed AWS backends may provide this automatically; otherwise the ambient AWS region is used.

minLength: 1

maxLength: 256

secretRef object

Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

serviceName string

AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.

minLength: 1

maxLength: 256

key string

Inline API key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

Where API keys are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object

Credential source for the API key, defaulting to a Kubernetes `Secret`. By default, the value is read from the `Authorization` key; set `secretRef.key` to override it. A `Bearer ` prefix is stripped only from the default `Authorization` key.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

HTTP protocol version for backend connections. If unset, it is inferred: `Service` appProtocol, `HTTP2` for gRPC, the original protocol for plaintext HTTP, or `HTTP1` for HTTPS because clients often upgrade HTTPS to HTTP/2 even when the backend does not support it.

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

CA certificate source to use to verify the server certificate. Omitted kind and `ConfigMap` select a ConfigMap; `Secret` selects a Secret. The `ca.crt` key is required. If unset, the system's trusted certificates are used.

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

Originates TLS but skips verification of the backend's certificate WARNING: insecure; only use if the risks are understood Modes: * `All` disables all TLS verification * `Hostname` trusts the CA certificate but ignores hostname/SAN mismatches. Still insecure; prefer `verifySubjectAltNames` where possible.

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

Enables mutual TLS to the backend using `tls.key` and `tls.crt` from the referenced credential source (defaulting to a Kubernetes `Secret`). An optional `ca.cert`, if present, verifies the server certificate, but `caCertificateRefs` takes priority. If unspecified, no client certificate is used.

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

`url` directly specifies the HTTP(S) endpoint for this policy. When the scheme is `https`, backend TLS is enabled automatically. Mutually exclusive with `backendRef`. URLs are opaque; referencing a Kubernetes service hostname like `hello.ns.svc.cluster.local` will not apply Service policies or load balancing.

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

region string required

AWS region where the guardrail is deployed, for example `us-west-2`).

minLength: 1

maxLength: 256

version string required

Version of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

googleModelArmor object

Google Model Armor settings for prompt guarding.

action string

Action controls whether flagged content is rejected or only observed. `Reject` (the default) rejects flagged content; `Audit` records the would-be rejection without blocking.

enum: Audit, Reject

location string

Google Cloud location, for example `us-central1`. Defaults to `us-central1` if not specified.

minLength: 1

maxLength: 256

policies object

Policies for communicating with Google Model Armor.

auth object

Settings for authenticating to Google Model Armor.

gcp object

Google authentication method for Model Armor. Use `gcp: {}` for default Google credential discovery.

audience string

Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.

minLength: 1

maxLength: 256

secretRef object

Credential source for ADC-compatible Google credential JSON, defaulting to a Kubernetes `Secret`. By default, the value is read from `credentials.json`; set `secretRef.key` to override it. When omitted, ambient credentials are used.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

type string

The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.

enum: AccessToken, IdToken

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

projectId string required

Google Cloud project ID.

minLength: 1

maxLength: 256

templateId string required

Template ID for Google Model Armor.

minLength: 1

maxLength: 256

openAIModeration object

Passes prompt data through the OpenAI Moderations endpoint. See https://developers.openai.com/api/reference/resources/moderations for more information.

action string

Action controls whether flagged content is rejected or only observed. `Reject` (the default) rejects flagged content; `Audit` records the would-be rejection without blocking.

enum: Audit, Reject

model string

Moderation model to use. For example, `omni-moderation`.

policies object

Policies for communicating with OpenAI.

auth object

Settings for authenticating to OpenAI.

key string

Inline key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

Where backend credentials are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object

Credential source for the authorization value, defaulting to a Kubernetes `Secret`. By default, the value is read from the `Authorization` key; set `secretRef.key` to override it. A `Bearer ` prefix is stripped only from the default `Authorization` key.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

regex object

Regular expression (regex) matching for prompt guards and data masking.

action string

The action to take if a regex pattern is matched in a request or response. The action applies to request and response matches alike. Note that `Mask` is not applied to streamed responses: matched content in a streamed response is passed through unmodified. Defaults to `Mask`.

enum: Audit, Mask, Reject

builtins []string

Built-in regex patterns to match against the request or response. Matches and built-ins are additive.

matches []string

Regex patterns to match against the request or response. Matches and built-ins are additive.

response object

Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.

message string

Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.

statusCode integer

Status code to return to the client. Defaults to 403.

format: int32

minimum: 200

maximum: 599

scope []string

Which parts of the request this guard inspects. When unset, defaults to `SystemPrompt` and `Messages`. Tool call inputs and outputs are not inspected unless `ToolInput`/`ToolOutput` are listed explicitly. In APIs that send tool arguments as opaque JSON, such as Completions, the arguments are masked as a single string, meaning a prompt guard has the potential to rewrite the arguments into invalid JSON.

minItems: 1

maxItems: 4

webhook object

Webhook that receives requests for prompt guarding.

action string

Action controls whether the webhook's verdict is enforced or only observed. `Reject` (the default) enforces it; `Audit` records the would-be action without blocking or masking.

enum: Audit, Reject

backendRef object required

Webhook server to reach. Supported types: Service and Backend.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

failureMode string

Behavior when the webhook guardrail is unavailable or returns an error. `FailOpen` allows the request to continue. `FailClosed` (default) rejects the request.

enum: FailClosed, FailOpen

forwardHeaderMatches []object

HTTP header matches used to select the headers to forward to the webhook. Request headers are used when forwarding requests and response headers are used when forwarding responses. By default, no headers are forwarded.

name string required

Name of the HTTP header to match, case-insensitive. When names are equivalent, only the first matching entry is used

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

type string

How to match against the header value: `Exact` (default) or `RegularExpression`. The regex dialect is implementation-specific

enum: Exact, RegularExpression

value string required

Value of the HTTP header to match

minLength: 1

maxLength: 4096

headers object

CEL-computed headers to include in webhook requests.

response []object

Prompt guards to apply to responses returned by the LLM provider.

minItems: 1

maxItems: 8

bedrockGuardrails object

AWS Bedrock Guardrails settings for prompt guarding.

action string

enum: Audit, Reject

identifier string required

Identifier of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

policies object

Policies for communicating with AWS Bedrock Guardrails.

auth object

Settings for authenticating to AWS Bedrock Guardrails.

aws object

AWS authentication method for Bedrock Guardrails. Use `aws: {}` for default AWS SDK credential discovery.

assumeRole object

AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.

roleArn string required

AWS IAM role ARN to assume.

pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$

minLength: 1

sessionName string

SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.

pattern: ^[\w+=,.@-]{2,64}$

sessionNameExpression string

minLength: 1

maxLength: 16384

tags []object

Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.

maxItems: 50

expression string

CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.

minLength: 1

maxLength: 16384

key string required

Key is the tag key.

minLength: 1

maxLength: 128

value string

Value is a static tag value.

maxLength: 256

region string

minLength: 1

maxLength: 256

secretRef object

Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

serviceName string

AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.

minLength: 1

maxLength: 256

key string

Inline API key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

Where API keys are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

region string required

AWS region where the guardrail is deployed, for example `us-west-2`).

minLength: 1

maxLength: 256

version string required

Version of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

googleModelArmor object

Google Model Armor settings for prompt guarding.

action string

Action controls whether flagged content is rejected or only observed. `Reject` (the default) rejects flagged content; `Audit` records the would-be rejection without blocking.

enum: Audit, Reject

location string

Google Cloud location, for example `us-central1`. Defaults to `us-central1` if not specified.

minLength: 1

maxLength: 256

policies object

Policies for communicating with Google Model Armor.

auth object

Settings for authenticating to Google Model Armor.

gcp object

Google authentication method for Model Armor. Use `gcp: {}` for default Google credential discovery.

audience string

Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

type string

The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.

enum: AccessToken, IdToken

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

projectId string required

Google Cloud project ID.

minLength: 1

maxLength: 256

templateId string required

Template ID for Google Model Armor.

minLength: 1

maxLength: 256

regex object

Regular expression (regex) matching for prompt guards and data masking.

action string

enum: Audit, Mask, Reject

builtins []string

Built-in regex patterns to match against the request or response. Matches and built-ins are additive.

matches []string

Regex patterns to match against the request or response. Matches and built-ins are additive.

response object

Custom response message to return to the client. If not specified, defaults to `The response was rejected due to inappropriate content`.

message string

Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.

statusCode integer

Status code to return to the client. Defaults to 403.

format: int32

minimum: 200

maximum: 599

webhook object

Webhook that receives responses for prompt guarding.

action string

Action controls whether the webhook's verdict is enforced or only observed. `Reject` (the default) enforces it; `Audit` records the would-be action without blocking or masking.

enum: Audit, Reject

backendRef object required

Webhook server to reach. Supported types: Service and Backend.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

failureMode string

Behavior when the webhook guardrail is unavailable or returns an error. `FailOpen` allows the request to continue. `FailClosed` (default) rejects the request.

enum: FailClosed, FailOpen

forwardHeaderMatches []object

name string required

Name of the HTTP header to match, case-insensitive. When names are equivalent, only the first matching entry is used

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

type string

How to match against the header value: `Exact` (default) or `RegularExpression`. The regex dialect is implementation-specific

enum: Exact, RegularExpression

value string required

Value of the HTTP header to match

minLength: 1

maxLength: 4096

headers object

CEL-computed headers to include in webhook requests.

streaming string

Apply prompt guards to streaming responses and realtime websocket messages. Defaults to disabled to preserve streaming throughput unless explicitly enabled.

enum: Enabled

routes object

Rules for identifying the type of traffic to handle. The keys are URL path suffixes matched using ends-with comparison, for example `"/v1/chat/completions"`. The special `*` wildcard matches any path. If not specified, all traffic defaults to `completions` type.

transformations []object

minItems: 1

maxItems: 64

expression string required

CEL expression used to compute the field value.

minLength: 1

maxLength: 16384

field string required

Name of the field to set.

minLength: 1

maxLength: 256

auth object

Settings for managing authentication to the backend

aws object

Explicit AWS authentication method for the backend. When omitted, default AWS SDK credential discovery is used.

assumeRole object

AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.

roleArn string required

AWS IAM role ARN to assume.

pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$

minLength: 1

sessionName string

SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.

pattern: ^[\w+=,.@-]{2,64}$

sessionNameExpression string

minLength: 1

maxLength: 16384

tags []object

Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.

maxItems: 50

expression string

CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.

minLength: 1

maxLength: 16384

key string required

Key is the tag key.

minLength: 1

maxLength: 128

value string

Value is a static tag value.

maxLength: 256

region string

minLength: 1

maxLength: 256

secretRef object

Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

serviceName string

AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.

minLength: 1

maxLength: 256

azure object

Azure authentication method for the backend.

managedIdentity object

Managed identity authentication settings. Leave this object empty to use the system-assigned identity. To use a user-assigned identity, set one of `clientId`, `objectId`, or `resourceId`.

clientId string

Client ID of the user-assigned managed identity.

objectId string

Object ID of the user-assigned managed identity.

resourceId string

Resource ID of the user-assigned managed identity.

secretRef object

Credential source for Azure credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `clientID`, `tenantID`, and `clientSecret` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

workloadIdentity object

Workload identity authentication settings. Uses the federated token and Azure env vars projected into the data plane pod. Recommended on AKS with Workload Identity enabled.

credentials []object

Credentials is a list of additional credentials to inject on the backend request. Each entry resolves a Secret key and writes its value to the entry's location. `credentials` is independent of the primary `key`/`secretRef`/`passthrough` mechanism and may be set on its own or alongside it.

minItems: 1

maxItems: 8

location object required

Where the credential is inserted on the backend request.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object required

SecretRef references a Kubernetes Secret holding the credential value, and optionally overrides the key read from it. Defaults to `Authorization`, matching the key convention used by the top-level `secretRef`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

crossAppAccess object

Cross App Access (Identity Assertion / ID-JAG) authentication.

accessTokenScopes []string

Scopes requested when exchanging the ID-JAG for an access token. When omitted, defaults to Scopes. Set to an empty list to omit scope.

maxItems: 64

audience string required

Identifier of the resource authorization server. The issued ID-JAG is bound to this audience.

minLength: 1

maxLength: 256

cache object

Response cache configuration.

inMemory object

defaultTtl string

TTL used when the token endpoint omits expires_in. Default 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

maxEntries integer

Default 8192; 0 disables the cache.

format: int32

identityProvider object required

User identity provider authorization server, used for the RFC 8693 ID-JAG exchange.

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

clientAuth object required

Client authentication for the token endpoint.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

PEM-encoded X.509 certificate chain, leaf first, for certificateHeader. The leaf public key should match signingKeyRef; a mismatch only logs a warning but the token endpoint will reject the assertions. Required when certificateHeader is set. The key defaults to `certificate`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

resourceAuthorizationServer object required

Resource authorization server, used for the RFC 7523 jwt-bearer exchange.

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

clientAuth object required

Client authentication for the token endpoint.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

resources []string

Resources sent to the token endpoint.

minItems: 1

maxItems: 64

scopes []string

Scopes requested when obtaining the ID-JAG from the identity provider.

minItems: 1

maxItems: 64

subjectToken object

Subject token sent to the identity provider. Defaults to an OpenID Connect ID token read from the Authorization Bearer header.

source object

Where to read the subject token. Defaults to the Authorization Bearer header.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth RFC 8693 subject token type. Defaults to IdToken

gcp object

Google authentication method for the backend. When omitted, default Google credential discovery is used.

audience string

Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

type string

The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.

enum: AccessToken, IdToken

jwtSign object

Signs a short-lived JWT with a private key on each request and sends it to the backend, for upstreams that require per-request keypair JWTs (e.g. the Snowflake SQL API) rather than a static credential.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

claims object

Static claims added to every token (e.g. iss, sub, aud). Values may be any JSON value (e.g. a string, number, bool, or array). iat, exp, and nbf are reserved for the signer and cannot be configured here; the controller rejects them at translation time.

kid string

Optional JWS key ID header.

location object

Where the signed token is written on the backend request. Defaults to the Authorization header with a "Bearer " prefix.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

signingKeyRef object required

Secret providing the `signingKey` key with a PEM-encoded RSA or EC private key.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

ttl string

Token lifetime used for exp. Defaults to 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

key string

Inline key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

Where backend credentials are inserted. If omitted, credentials are written to the `Authorization` header with the `Bearer ` prefix. This applies to `key`, `secretRef`, and `passthrough`. Entries in `credentials` carry their own location.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

oauthTokenExchange object

OAuth 2.0 token exchange (RFC 8693) / jwt-bearer (RFC 7523) authentication.

actorToken object

RFC 8693 delegation actor token. TokenExchange grant only.

mayAct string

may_act claim validation mode. When omitted, may_act is not enforced.

enum: Required

source object required

Where to read the actor token. Actor tokens have no default source.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth token type. Empty defaults to AccessToken. Custom absolute URI values are supported for actor tokens.

additionalParams object

Extra form params; values are CEL expressions over the incoming request.

audiences []string

Audiences sent to the token endpoint.

minItems: 1

maxItems: 64

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

cache object

Response cache configuration.

inMemory object

defaultTtl string

TTL used when the token endpoint omits expires_in. Default 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

maxEntries integer

Default 8192; 0 disables the cache.

format: int32

clientAuth object

Client authentication for the token endpoint. When unset, none is sent.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

grantType string

RFC followed by the request. Defaults to TokenExchange (RFC 8693).

enum: JwtBearer, TokenExchange

location object

Where the exchanged token is written to the backend request. Defaults to Authorization: Bearer.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

requestedTokenType string

RFC 8693 requested_token_type. Unlike subject/actor token types, only the built-in values may be requested; custom URIs are not supported here.

enum: AccessToken, Jwt, IdToken, IdJag

resources []string

Resources sent to the token endpoint.

minItems: 1

maxItems: 64

scopes []string

Scopes sent to the token endpoint.

minItems: 1

maxItems: 64

subjectToken object

Subject token / assertion source and type. Defaults to Authorization Bearer, AccessToken. The token type may be a built-in value or a custom absolute URI for providers that support custom token exchange profiles.

source object

Where to read the token. CEL `expression` variant is permitted.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth token type. Empty defaults to AccessToken. Custom absolute URI values are supported for subject tokens.

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

passthrough object

Reuses a client token already validated by another policy. Those policies may strip client credentials; passthrough adds the original token back to the backend request. Without client auth policies, this has no effect.

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

health object

Settings for passive and active health checking.

eviction object

Settings for evicting unhealthy backends.

consecutiveFailures integer

Number of consecutive unhealthy responses required before the backend is evicted. For example, a value of 5 means the backend must receive 5 unhealthy responses in a row before being evicted. When both consecutiveFailures and healthThreshold are set, the backend is evicted when either condition is met. When neither is set, a single unhealthy response can trigger eviction.

format: int32

minimum: 0

duration string

Base time a backend should be evicted after being marked unhealthy. Subsequent evictions use multiplicative backoff (duration * times_evicted). If all endpoints are evicted, the load balancer falls back to returning evicted endpoints rather than failing entirely. If unset, defaults to `3s`.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

healthThreshold integer

EWMA health score threshold, from 0 to 100. When set, a backend is evicted only if its computed health drops below this value after an unhealthy response (e.g. 50 evicts when EWMA health falls below 50%). Unlike consecutiveFailures, this sliding-window average lets a single success delay eviction. If both are set, either condition evicts; if neither, a single unhealthy response evicts.

format: int32

minimum: 0

maximum: 100

restoreHealth integer

Health score from 0 to 100 assigned to a backend when it returns from eviction. For gradual recovery, set below 100; for full recovery immediately, set 100. If unset, the backend resumes with the health it had when evicted.

format: int32

minimum: 0

maximum: 100

unhealthyCondition string

CEL expression that determines whether a response indicates an unhealthy backend. When the expression evaluates to true, the backend is considered unhealthy and may be evicted. For example, to evict on 5xx responses: `response.code >= 500`. When unset, any 5xx response, or a connection failure, is treated as unhealthy. This default lowers the backend's health score but does not trigger eviction on its own.

minLength: 1

maxLength: 16384

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

transformation object

Mutates and transforms requests and responses sent to and from the backend.

request object

Request transformation settings.

add []object

Headers to add to the request and what each value should be set to. If there is already a header with these values then append the value as an extra entry.

minItems: 1

maxItems: 16

name string required

The name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

CEL expression that generates the output value for the header.

minLength: 1

maxLength: 16384

body string

HTTP body transformation.

minLength: 1

maxLength: 16384

metadata object

Stores CEL-evaluated values under the `metadata` CEL variable for subsequent policy evaluations. `metadata` is evaluated before header or body transformations.

remove []string

Header names to remove from the request or response.

minItems: 1

maxItems: 16

set []object

Headers to set and the values to use.

minItems: 1

maxItems: 16

name string required

The name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

CEL expression that generates the output value for the header.

minLength: 1

maxLength: 16384

response object

Response transformation settings.

add []object

Headers to add to the request and what each value should be set to. If there is already a header with these values then append the value as an extra entry.

minItems: 1

maxItems: 16

name string required

The name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

CEL expression that generates the output value for the header.

minLength: 1

maxLength: 16384

body string

HTTP body transformation.

minLength: 1

maxLength: 16384

metadata object

Stores CEL-evaluated values under the `metadata` CEL variable for subsequent policy evaluations. `metadata` is evaluated before header or body transformations.

remove []string

Header names to remove from the request or response.

minItems: 1

maxItems: 16

set []object

Headers to set and the values to use.

minItems: 1

maxItems: 16

name string required

The name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

CEL expression that generates the output value for the header.

minLength: 1

maxLength: 16384

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

port integer

Port to send requests to.

format: int32

minimum: 1

maximum: 65535

vertexai object

Vertex AI provider settings.

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

projectId string required

The ID of the Google Cloud Project that you use for the Vertex AI.

minLength: 1

maxLength: 64

region string

The location of the Google Cloud Project that you use for the Vertex AI. Special values: `global` uses the global endpoint, while `us` and `eu` use restricted multi-region endpoints. Other values are treated as regional locations. Defaults to `global` if not specified.

minLength: 1

maxLength: 64

provider object

Configuration for how to reach the configured LLM provider.

anthropic object

Anthropic provider settings.

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

azure object

Azure provider with resource-based configuration. Supports both Azure OpenAI and Azure AI Foundry resource types.

apiVersion string

The version of the Azure OpenAI API to use. If unset, defaults to `v1`.

minLength: 1

maxLength: 64

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

projectName string

The Foundry project name, required when `resourceType` is `Foundry`. Used to construct paths: /api/projects/{projectName}/openai/v1/...

minLength: 1

maxLength: 256

resourceName string required

minLength: 1

maxLength: 256

resourceType string required

The type of Azure endpoint. Determines the host suffix.

enum: Foundry, OpenAI

azureopenai object

Azure OpenAI provider settings.

apiVersion string

minLength: 1

maxLength: 64

deploymentName string

minLength: 1

maxLength: 256

endpoint string required

The endpoint for the Azure OpenAI API to use, such as `my-endpoint.openai.azure.com`. If the scheme is included, it is stripped.

minLength: 1

maxLength: 256

bedrock object

Bedrock provider settings.

guardrail object

Guardrail policy to use for the backend. See <https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html>. If not specified, the AWS Guardrail policy will not be used.

identifier string required

Identifier of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

version string required

Version of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

region string

AWS region to use for the backend. Defaults to `us-east-1` if not specified.

pattern: ^[a-z0-9-]+$

minLength: 1

maxLength: 63

custom object

backendRef object

Kubernetes backend that serves this provider. `backendRef` may target only a namespace-local Service or InferencePool. If unset, host and port must be set on the parent provider.

group string

API group of the referenced resource. For example, `gateway.networking.k8s.io`. When unspecified or empty string, core API group is inferred.

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kind of the referenced resource. For example, `Service`. Defaults to "Service" when not specified.

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name of the referenced resource.

minLength: 1

maxLength: 253

port integer

Destination port number to use for this resource. Required when the referenced resource is a Kubernetes Service.

format: int32

minimum: 1

maximum: 65535

formats []object required

Provider-native API formats this provider supports.

minItems: 1

maxItems: 6

path string

Default upstream path override for this format. If unset, agentgateway uses the default path for the format.

minLength: 1

maxLength: 1024

type string required

Provider-native API format.

enum: AnthropicTokenCount, Completions, Embeddings, Messages, Realtime, Rerank, Responses

model string

Model name override, such as `gpt-oss`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

providerOverride string

Provider identity used for cost-catalog lookup and telemetry. Defaults to "custom" when unset.

minLength: 1

maxLength: 256

gemini object

Gemini provider settings.

model string

Model name override, such as `gemini-2.5-pro`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

host string

Hostname to send requests to. For custom providers without backendRef, host and port specify the target. For managed providers, host and port override the provider default.

minLength: 1

maxLength: 256

openai object

OpenAI provider settings.

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

moderation object

Inline moderation configuration to inject into OpenAI chat completions and responses requests. If unset, the OpenAI inline moderation parameter is not injected.

model string

The moderation model to use, such as `omni-moderation-latest`. Defaults to `omni-moderation-latest` if not specified.

minLength: 1

maxLength: 256

policy object

Policies to apply to request input and generated output.

input object

Policy for request input moderation.

mode string required

Mode controls whether moderation only returns scores or blocks flagged content.

enum: Block, Score

output object

Policy for generated output moderation.

mode string required

Mode controls whether moderation only returns scores or blocks flagged content.

enum: Block, Score

path string

minLength: 1

maxLength: 1024

pathPrefix string

minLength: 1

maxLength: 1024

port integer

Port to send requests to.

format: int32

minimum: 1

maximum: 65535

vertexai object

Vertex AI provider settings.

model string

Model name override, such as `gpt-4o-mini`. If unset, the model name is taken from the request.

minLength: 1

maxLength: 256

projectId string required

The ID of the Google Cloud Project that you use for the Vertex AI.

minLength: 1

maxLength: 64

region string

minLength: 1

maxLength: 64

aws object

AWS service backend, such as AgentCore.

agentCore object

Amazon Bedrock AgentCore backend settings.

agentRuntimeArn string required

ARN of the AgentCore runtime.

qualifier string

Alias or version qualifier.

dynamicForwardProxy object

Dynamically sends requests to the destination based on the incoming request HTTP host header, or TLS SNI for TLS traffic. Warning: this backend type can send requests to arbitrary destinations. Proper access controls must be put in place when using this backend type.

mcp object

MCP backend.

failureMode string

Behavior when MCP targets fail to initialize or become unavailable at runtime. `FailOpen` skips failed targets and continues serving from healthy ones. `FailClosed` (default) fails the entire session if any target fails.

enum: FailClosed, FailOpen

prefixMode string

How tool and prompt names are prefixed with the target name. Resource URIs always retain target routing information when multiplexing and are unaffected. `Conditional` (default) prefixes only when there are multiple targets. `Always` prefixes even with a single target. `Never` exposes unprefixed names and routes calls by looking up which target serves the name; names must be unique across targets.

enum: Always, Conditional, Never

sessionRouting string

MCP session routing behavior. Defaults to `Stateful` if not set.

enum: Stateful, Stateless

targets []object required

MCP targets to use for this backend. Policies targeting MCP targets must use `targetRefs[].sectionName` to select the target by name.

minItems: 1

maxItems: 128

name string required

Name of the MCP target.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

selector object

Label selector used to select `Service` resources. If policies are needed on a per-service basis, `AgentgatewayPolicy` can target the desired `Service`.

namespaces object

`namespace` is the label selector for namespaces that `Service` resources should be selected from. If unset, only the namespace of the `AgentgatewayBackend` is searched.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchLabels object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

services object

`services` is the label selector for which `Service` resources should be selected.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

matchLabels object

static object

Static MCP destination. When connecting to in-cluster `Service` resources, it is recommended to use `selector` instead.

backendRef object

Namespace-local `Service` resource by name. When set, this replaces `host` only; `port`, `path`, and `protocol` remain configured on this target.

name string

Name of the referent

host string

Hostname or IP address of the MCP target.

minLength: 1

maxLength: 256

path string

URL path of the MCP target endpoint. Defaults to `"/sse"` for the `SSE` protocol or `"/mcp"` for the `StreamableHTTP` protocol if not specified.

minLength: 1

maxLength: 1024

policies object

auth object

Settings for managing authentication to the backend

aws object

Explicit AWS authentication method for the backend. When omitted, default AWS SDK credential discovery is used.

assumeRole object

AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.

roleArn string required

AWS IAM role ARN to assume.

pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$

minLength: 1

sessionName string

SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.

pattern: ^[\w+=,.@-]{2,64}$

sessionNameExpression string

minLength: 1

maxLength: 16384

tags []object

Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.

maxItems: 50

expression string

CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.

minLength: 1

maxLength: 16384

key string required

Key is the tag key.

minLength: 1

maxLength: 128

value string

Value is a static tag value.

maxLength: 256

region string

minLength: 1

maxLength: 256

secretRef object

Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

serviceName string

AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.

minLength: 1

maxLength: 256

azure object

Azure authentication method for the backend.

managedIdentity object

Managed identity authentication settings. Leave this object empty to use the system-assigned identity. To use a user-assigned identity, set one of `clientId`, `objectId`, or `resourceId`.

clientId string

Client ID of the user-assigned managed identity.

objectId string

Object ID of the user-assigned managed identity.

resourceId string

Resource ID of the user-assigned managed identity.

secretRef object

Credential source for Azure credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `clientID`, `tenantID`, and `clientSecret` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

workloadIdentity object

Workload identity authentication settings. Uses the federated token and Azure env vars projected into the data plane pod. Recommended on AKS with Workload Identity enabled.

credentials []object

minItems: 1

maxItems: 8

location object required

Where the credential is inserted on the backend request.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object required

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

crossAppAccess object

Cross App Access (Identity Assertion / ID-JAG) authentication.

accessTokenScopes []string

Scopes requested when exchanging the ID-JAG for an access token. When omitted, defaults to Scopes. Set to an empty list to omit scope.

maxItems: 64

audience string required

Identifier of the resource authorization server. The issued ID-JAG is bound to this audience.

minLength: 1

maxLength: 256

cache object

Response cache configuration.

inMemory object

defaultTtl string

TTL used when the token endpoint omits expires_in. Default 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

maxEntries integer

Default 8192; 0 disables the cache.

format: int32

identityProvider object required

User identity provider authorization server, used for the RFC 8693 ID-JAG exchange.

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

clientAuth object required

Client authentication for the token endpoint.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

resourceAuthorizationServer object required

Resource authorization server, used for the RFC 7523 jwt-bearer exchange.

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

clientAuth object required

Client authentication for the token endpoint.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

resources []string

Resources sent to the token endpoint.

minItems: 1

maxItems: 64

scopes []string

Scopes requested when obtaining the ID-JAG from the identity provider.

minItems: 1

maxItems: 64

subjectToken object

Subject token sent to the identity provider. Defaults to an OpenID Connect ID token read from the Authorization Bearer header.

source object

Where to read the subject token. Defaults to the Authorization Bearer header.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth RFC 8693 subject token type. Defaults to IdToken

gcp object

Google authentication method for the backend. When omitted, default Google credential discovery is used.

audience string

Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

type string

The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.

enum: AccessToken, IdToken

jwtSign object

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

claims object

kid string

Optional JWS key ID header.

location object

Where the signed token is written on the backend request. Defaults to the Authorization header with a "Bearer " prefix.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

signingKeyRef object required

Secret providing the `signingKey` key with a PEM-encoded RSA or EC private key.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

ttl string

Token lifetime used for exp. Defaults to 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

key string

Inline key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

oauthTokenExchange object

OAuth 2.0 token exchange (RFC 8693) / jwt-bearer (RFC 7523) authentication.

actorToken object

RFC 8693 delegation actor token. TokenExchange grant only.

mayAct string

may_act claim validation mode. When omitted, may_act is not enforced.

enum: Required

source object required

Where to read the actor token. Actor tokens have no default source.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth token type. Empty defaults to AccessToken. Custom absolute URI values are supported for actor tokens.

additionalParams object

Extra form params; values are CEL expressions over the incoming request.

audiences []string

Audiences sent to the token endpoint.

minItems: 1

maxItems: 64

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

cache object

Response cache configuration.

inMemory object

defaultTtl string

TTL used when the token endpoint omits expires_in. Default 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

maxEntries integer

Default 8192; 0 disables the cache.

format: int32

clientAuth object

Client authentication for the token endpoint. When unset, none is sent.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

grantType string

RFC followed by the request. Defaults to TokenExchange (RFC 8693).

enum: JwtBearer, TokenExchange

location object

Where the exchanged token is written to the backend request. Defaults to Authorization: Bearer.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

requestedTokenType string

RFC 8693 requested_token_type. Unlike subject/actor token types, only the built-in values may be requested; custom URIs are not supported here.

enum: AccessToken, Jwt, IdToken, IdJag

resources []string

Resources sent to the token endpoint.

minItems: 1

maxItems: 64

scopes []string

Scopes sent to the token endpoint.

minItems: 1

maxItems: 64

subjectToken object

source object

Where to read the token. CEL `expression` variant is permitted.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth token type. Empty defaults to AccessToken. Custom absolute URI values are supported for subject tokens.

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

passthrough object

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

port integer required

Port number of the MCP target.

format: int32

minimum: 1

maximum: 65535

protocol string

Protocol to use for the connection to the MCP target.

enum: SSE, StreamableHTTP

policies object

Policies for communicating with this backend. Policies may also be set with AgentgatewayPolicy. Backend policies take precedence over policy resources when they set the same field.

ai object

Settings for AI workloads. This is only applicable when connecting to a `Backend` of type `ai`.

defaults []object

Defaults to merge with user input fields. If the field is already set, the field in the request is used.

minItems: 1

maxItems: 64

field string required

Name of the field.

minLength: 1

maxLength: 256

value object required

Default value for the field. This can be any JSON data type.

finalTransformations []object

minItems: 1

maxItems: 64

expression string required

CEL expression used to compute the field value.

minLength: 1

maxLength: 16384

field string required

Name of the field to set.

minLength: 1

maxLength: 256

modelAliases object

Maps friendly model names to actual provider model names. Example: `{"fast": "gpt-3.5-turbo", "smart": "gpt-4-turbo"}`. Note: This field is only applicable when using the agentgateway data plane.

overrides []object

Overrides to merge with user input fields. If the field is already set, the field is overwritten.

minItems: 1

maxItems: 64

field string required

Name of the field.

minLength: 1

maxLength: 256

value object required

Default value for the field. This can be any JSON data type.

prompt object

Enriches requests sent to the LLM provider by appending and prepending system prompts. This can be configured only for LLM providers that use the `CHAT` or `CHAT_STREAMING` API route type.

append []object

Messages to append to the prompt sent by the client.

content string required

String content of the message.

role string required

Role of the message. The available roles depend on the backend LLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.

prepend []object

Messages to prepend to the prompt sent by the client.

content string required

String content of the message.

role string required

Role of the message. The available roles depend on the backend LLM provider model, such as `SYSTEM` or `USER` in the OpenAI API.

promptCaching object

cacheMessageOffset integer

Shifts the message cache point further back in the conversation. 0 (default) places it at the second-to-last message. Higher values move it N additional messages towards the start, clamped to bounds.

minimum: 0

cacheMessages boolean

Enables caching for conversation messages. Caches all messages in the conversation for cost savings.

cacheSystem boolean

Enables caching for system prompts. Inserts a cache point after all system messages.

cacheTools boolean

Enables caching for tool definitions. Inserts a cache point after all tool specifications.

minTokens integer

Minimum estimated token count before caching is enabled. Uses rough heuristic (word count × 1.3) to estimate tokens. Bedrock requires at least 1,024 tokens for caching to be effective.

minimum: 0

promptGuard object

Guardrails for LLM requests and responses.

request []object

Prompt guards to apply to requests sent by the client.

minItems: 1

maxItems: 8

bedrockGuardrails object

AWS Bedrock Guardrails settings for prompt guarding.

action string

enum: Audit, Reject

identifier string required

Identifier of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

policies object

Policies for communicating with AWS Bedrock Guardrails.

auth object

Settings for authenticating to AWS Bedrock Guardrails.

aws object

AWS authentication method for Bedrock Guardrails. Use `aws: {}` for default AWS SDK credential discovery.

assumeRole object

AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.

roleArn string required

AWS IAM role ARN to assume.

pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$

minLength: 1

sessionName string

SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.

pattern: ^[\w+=,.@-]{2,64}$

sessionNameExpression string

minLength: 1

maxLength: 16384

tags []object

Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.

maxItems: 50

expression string

CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.

minLength: 1

maxLength: 16384

key string required

Key is the tag key.

minLength: 1

maxLength: 128

value string

Value is a static tag value.

maxLength: 256

region string

minLength: 1

maxLength: 256

secretRef object

Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

serviceName string

AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.

minLength: 1

maxLength: 256

key string

Inline API key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

Where API keys are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

region string required

AWS region where the guardrail is deployed, for example `us-west-2`).

minLength: 1

maxLength: 256

version string required

Version of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

googleModelArmor object

Google Model Armor settings for prompt guarding.

action string

Action controls whether flagged content is rejected or only observed. `Reject` (the default) rejects flagged content; `Audit` records the would-be rejection without blocking.

enum: Audit, Reject

location string

Google Cloud location, for example `us-central1`. Defaults to `us-central1` if not specified.

minLength: 1

maxLength: 256

policies object

Policies for communicating with Google Model Armor.

auth object

Settings for authenticating to Google Model Armor.

gcp object

Google authentication method for Model Armor. Use `gcp: {}` for default Google credential discovery.

audience string

Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

type string

The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.

enum: AccessToken, IdToken

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

projectId string required

Google Cloud project ID.

minLength: 1

maxLength: 256

templateId string required

Template ID for Google Model Armor.

minLength: 1

maxLength: 256

openAIModeration object

Passes prompt data through the OpenAI Moderations endpoint. See https://developers.openai.com/api/reference/resources/moderations for more information.

action string

Action controls whether flagged content is rejected or only observed. `Reject` (the default) rejects flagged content; `Audit` records the would-be rejection without blocking.

enum: Audit, Reject

model string

Moderation model to use. For example, `omni-moderation`.

policies object

Policies for communicating with OpenAI.

auth object

Settings for authenticating to OpenAI.

key string

Inline key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

Where backend credentials are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

regex object

Regular expression (regex) matching for prompt guards and data masking.

action string

enum: Audit, Mask, Reject

builtins []string

Built-in regex patterns to match against the request or response. Matches and built-ins are additive.

matches []string

Regex patterns to match against the request or response. Matches and built-ins are additive.

response object

Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.

message string

Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.

statusCode integer

Status code to return to the client. Defaults to 403.

format: int32

minimum: 200

maximum: 599

scope []string

minItems: 1

maxItems: 4

webhook object

Webhook that receives requests for prompt guarding.

action string

Action controls whether the webhook's verdict is enforced or only observed. `Reject` (the default) enforces it; `Audit` records the would-be action without blocking or masking.

enum: Audit, Reject

backendRef object required

Webhook server to reach. Supported types: Service and Backend.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

failureMode string

Behavior when the webhook guardrail is unavailable or returns an error. `FailOpen` allows the request to continue. `FailClosed` (default) rejects the request.

enum: FailClosed, FailOpen

forwardHeaderMatches []object

name string required

Name of the HTTP header to match, case-insensitive. When names are equivalent, only the first matching entry is used

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

type string

How to match against the header value: `Exact` (default) or `RegularExpression`. The regex dialect is implementation-specific

enum: Exact, RegularExpression

value string required

Value of the HTTP header to match

minLength: 1

maxLength: 4096

headers object

CEL-computed headers to include in webhook requests.

response []object

Prompt guards to apply to responses returned by the LLM provider.

minItems: 1

maxItems: 8

bedrockGuardrails object

AWS Bedrock Guardrails settings for prompt guarding.

action string

enum: Audit, Reject

identifier string required

Identifier of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

policies object

Policies for communicating with AWS Bedrock Guardrails.

auth object

Settings for authenticating to AWS Bedrock Guardrails.

aws object

AWS authentication method for Bedrock Guardrails. Use `aws: {}` for default AWS SDK credential discovery.

assumeRole object

AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.

roleArn string required

AWS IAM role ARN to assume.

pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$

minLength: 1

sessionName string

SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.

pattern: ^[\w+=,.@-]{2,64}$

sessionNameExpression string

minLength: 1

maxLength: 16384

tags []object

Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.

maxItems: 50

expression string

CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.

minLength: 1

maxLength: 16384

key string required

Key is the tag key.

minLength: 1

maxLength: 128

value string

Value is a static tag value.

maxLength: 256

region string

minLength: 1

maxLength: 256

secretRef object

Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

serviceName string

AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.

minLength: 1

maxLength: 256

key string

Inline API key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

Where API keys are inserted. Defaults to the `Authorization` header with the `Bearer ` prefix. Applies to `key` and `secretRef`.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

region string required

AWS region where the guardrail is deployed, for example `us-west-2`).

minLength: 1

maxLength: 256

version string required

Version of the Guardrail policy to use for the backend.

minLength: 1

maxLength: 256

googleModelArmor object

Google Model Armor settings for prompt guarding.

action string

Action controls whether flagged content is rejected or only observed. `Reject` (the default) rejects flagged content; `Audit` records the would-be rejection without blocking.

enum: Audit, Reject

location string

Google Cloud location, for example `us-central1`. Defaults to `us-central1` if not specified.

minLength: 1

maxLength: 256

policies object

Policies for communicating with Google Model Armor.

auth object

Settings for authenticating to Google Model Armor.

gcp object

Google authentication method for Model Armor. Use `gcp: {}` for default Google credential discovery.

audience string

Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

type string

The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.

enum: AccessToken, IdToken

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

projectId string required

Google Cloud project ID.

minLength: 1

maxLength: 256

templateId string required

Template ID for Google Model Armor.

minLength: 1

maxLength: 256

regex object

Regular expression (regex) matching for prompt guards and data masking.

action string

enum: Audit, Mask, Reject

builtins []string

Built-in regex patterns to match against the request or response. Matches and built-ins are additive.

matches []string

Regex patterns to match against the request or response. Matches and built-ins are additive.

response object

Custom response message to return to the client. If not specified, defaults to `The response was rejected due to inappropriate content`.

message string

Custom response message to return to the client. If not specified, defaults to `The request was rejected due to inappropriate content`.

statusCode integer

Status code to return to the client. Defaults to 403.

format: int32

minimum: 200

maximum: 599

webhook object

Webhook that receives responses for prompt guarding.

action string

Action controls whether the webhook's verdict is enforced or only observed. `Reject` (the default) enforces it; `Audit` records the would-be action without blocking or masking.

enum: Audit, Reject

backendRef object required

Webhook server to reach. Supported types: Service and Backend.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

failureMode string

Behavior when the webhook guardrail is unavailable or returns an error. `FailOpen` allows the request to continue. `FailClosed` (default) rejects the request.

enum: FailClosed, FailOpen

forwardHeaderMatches []object

name string required

Name of the HTTP header to match, case-insensitive. When names are equivalent, only the first matching entry is used

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

type string

How to match against the header value: `Exact` (default) or `RegularExpression`. The regex dialect is implementation-specific

enum: Exact, RegularExpression

value string required

Value of the HTTP header to match

minLength: 1

maxLength: 4096

headers object

CEL-computed headers to include in webhook requests.

streaming string

Apply prompt guards to streaming responses and realtime websocket messages. Defaults to disabled to preserve streaming throughput unless explicitly enabled.

enum: Enabled

routes object

transformations []object

minItems: 1

maxItems: 64

expression string required

CEL expression used to compute the field value.

minLength: 1

maxLength: 16384

field string required

Name of the field to set.

minLength: 1

maxLength: 256

auth object

Settings for managing authentication to the backend

aws object

Explicit AWS authentication method for the backend. When omitted, default AWS SDK credential discovery is used.

assumeRole object

AWS STS AssumeRole settings to use before signing backend requests. Ambient AWS credentials are used as the source credentials for STS.

roleArn string required

AWS IAM role ARN to assume.

pattern: ^arn:aws[a-z-]*:iam::[0-9]{12}:role/.+$

minLength: 1

sessionName string

SessionName is a custom session name (RoleSessionName) for CloudTrail and Cost & Usage Report attribution. If unset, AWS generates a random name.

pattern: ^[\w+=,.@-]{2,64}$

sessionNameExpression string

minLength: 1

maxLength: 16384

tags []object

Session tags passed to STS AssumeRole for cost attribution in the AWS Cost & Usage Report, once activated. STS allows at most 50 per role session.

maxItems: 50

expression string

CEL expression evaluated against each request to produce the tag value, for example `jwt.sub` or `request.headers["x-app"]`. Requests with invalid tag values are rejected.

minLength: 1

maxLength: 16384

key string required

Key is the tag key.

minLength: 1

maxLength: 128

value string

Value is a static tag value.

maxLength: 256

region string

minLength: 1

maxLength: 256

secretRef object

Credential source for AWS credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `accessKey`, `secretKey`, and optional `sessionToken` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

serviceName string

AWS SigV4 signing service name, for example `bedrock`, `bedrock-agentcore`, or `execute-api`). If unset, typed AWS backends may provide this automatically.

minLength: 1

maxLength: 256

azure object

Azure authentication method for the backend.

managedIdentity object

Managed identity authentication settings. Leave this object empty to use the system-assigned identity. To use a user-assigned identity, set one of `clientId`, `objectId`, or `resourceId`.

clientId string

Client ID of the user-assigned managed identity.

objectId string

Object ID of the user-assigned managed identity.

resourceId string

Resource ID of the user-assigned managed identity.

secretRef object

Credential source for Azure credentials, defaulting to a Kubernetes `Secret`. The default Secret resolver expects `clientID`, `tenantID`, and `clientSecret` keys.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

workloadIdentity object

Workload identity authentication settings. Uses the federated token and Azure env vars projected into the data plane pod. Recommended on AKS with Workload Identity enabled.

credentials []object

minItems: 1

maxItems: 8

location object required

Where the credential is inserted on the backend request.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

secretRef object required

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

crossAppAccess object

Cross App Access (Identity Assertion / ID-JAG) authentication.

accessTokenScopes []string

Scopes requested when exchanging the ID-JAG for an access token. When omitted, defaults to Scopes. Set to an empty list to omit scope.

maxItems: 64

audience string required

Identifier of the resource authorization server. The issued ID-JAG is bound to this audience.

minLength: 1

maxLength: 256

cache object

Response cache configuration.

inMemory object

defaultTtl string

TTL used when the token endpoint omits expires_in. Default 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

maxEntries integer

Default 8192; 0 disables the cache.

format: int32

identityProvider object required

User identity provider authorization server, used for the RFC 8693 ID-JAG exchange.

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

clientAuth object required

Client authentication for the token endpoint.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

resourceAuthorizationServer object required

Resource authorization server, used for the RFC 7523 jwt-bearer exchange.

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

clientAuth object required

Client authentication for the token endpoint.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

resources []string

Resources sent to the token endpoint.

minItems: 1

maxItems: 64

scopes []string

Scopes requested when obtaining the ID-JAG from the identity provider.

minItems: 1

maxItems: 64

subjectToken object

Subject token sent to the identity provider. Defaults to an OpenID Connect ID token read from the Authorization Bearer header.

source object

Where to read the subject token. Defaults to the Authorization Bearer header.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth RFC 8693 subject token type. Defaults to IdToken

gcp object

Google authentication method for the backend. When omitted, default Google credential discovery is used.

audience string

Explicit `aud` value for the ID token. Only valid with `IdToken` type. If not set, the `aud` is automatically derived from the backend hostname.

minLength: 1

maxLength: 256

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

type string

The type of token to generate. To authenticate to GCP services, generally an `AccessToken` is used. To authenticate to Cloud Run, an `IdToken` is used.

enum: AccessToken, IdToken

jwtSign object

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

claims object

kid string

Optional JWS key ID header.

location object

Where the signed token is written on the backend request. Defaults to the Authorization header with a "Bearer " prefix.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

signingKeyRef object required

Secret providing the `signingKey` key with a PEM-encoded RSA or EC private key.

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

ttl string

Token lifetime used for exp. Defaults to 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

key string

Inline key to use as the value of the `Authorization` header. This option is the least secure; usage of a `Secret` is preferred.

maxLength: 2048

location object

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

oauthTokenExchange object

OAuth 2.0 token exchange (RFC 8693) / jwt-bearer (RFC 7523) authentication.

actorToken object

RFC 8693 delegation actor token. TokenExchange grant only.

mayAct string

may_act claim validation mode. When omitted, may_act is not enforced.

enum: Required

source object required

Where to read the actor token. Actor tokens have no default source.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth token type. Empty defaults to AccessToken. Custom absolute URI values are supported for actor tokens.

additionalParams object

Extra form params; values are CEL expressions over the incoming request.

audiences []string

Audiences sent to the token endpoint.

minItems: 1

maxItems: 64

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

cache object

Response cache configuration.

inMemory object

defaultTtl string

TTL used when the token endpoint omits expires_in. Default 300s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

maxEntries integer

Default 8192; 0 disables the cache.

format: int32

clientAuth object

Client authentication for the token endpoint. When unset, none is sent.

clientId string required

Client ID sent to the token endpoint.

minLength: 1

method string

Client authentication method. Defaults to ClientSecretBasic.

enum: ClientSecretBasic, ClientSecretPost, PrivateKeyJwt

privateKeyJwt object

Client assertion settings. Required when method is PrivateKeyJwt.

alg string

JWS signing algorithm. Defaults to RS256.

enum: ES256, ES384, PS256, RS256, RS384, RS512

assertionAudience string required

Audience for the client assertion, typically the token endpoint URL.

minLength: 1

certificateHeader string

JWS certificate header. Required when certificateRef is set.

enum: x5c, x5t#S256

certificateRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

kid string

Optional JWS key ID header.

signingKeyRef object required

PEM-encoded RSA or EC private key; key defaults to `signingKey`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

secretRef object

Secret providing the `clientSecret` key by default; override via `secretRef.key`. When omitted, client_id is sent without a secret, which is only valid with ClientSecretPost.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

grantType string

RFC followed by the request. Defaults to TokenExchange (RFC 8693).

enum: JwtBearer, TokenExchange

location object

Where the exchanged token is written to the backend request. Defaults to Authorization: Bearer.

cookie object

name string required

minLength: 1

maxLength: 256

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

path string

Token endpoint path; defaults to "/". Must start with "/".

pattern: ^/

requestedTokenType string

RFC 8693 requested_token_type. Unlike subject/actor token types, only the built-in values may be requested; custom URIs are not supported here.

enum: AccessToken, Jwt, IdToken, IdJag

resources []string

Resources sent to the token endpoint.

minItems: 1

maxItems: 64

scopes []string

Scopes sent to the token endpoint.

minItems: 1

maxItems: 64

subjectToken object

source object

Where to read the token. CEL `expression` variant is permitted.

cookie object

name string required

minLength: 1

maxLength: 256

expression string

CEL expression that extracts the credential from the request.

minLength: 1

maxLength: 16384

header object

name string required

Name of an HTTP header. HTTP/2 pseudo-headers (names beginning with `:`) are not supported

pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

prefix string

minLength: 1

maxLength: 256

queryParameter object

name string required

minLength: 1

maxLength: 256

tokenType string

OAuth token type. Empty defaults to AccessToken. Custom absolute URI values are supported for subject tokens.

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

passthrough object

secretRef object

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

extAuth object

External authentication configuration for requests sent to this backend.

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

cache object

Caches authorization results. WARNING: the safety of this feature depends on the cache key accurately capturing every request property that the authorization service uses to make a decision. For example, if the service returns different results based on both path and authorization header, both must be included in `key`; otherwise, one request may incorrectly reuse another request's authorization result. If any key expression fails to evaluate or produces an unsupported value, the request is still sent to the authorization service, but its result is not read from or written to the cache.

key []string required

Ordered list of CEL expressions evaluated against the request to construct the cache key.

minItems: 1

maxItems: 16

maxEntries integer

Maximum number of authorization results to keep in the cache. If unset, this defaults to 10000.

format: int32

minimum: 1

ttl string required

Duration string, such as `5m`, or a CEL expression that returns the duration that cached authorization results may be reused, or a timestamp when the cached authorization result expires. The expression is evaluated after the authorization response has been applied to the request.

minLength: 1

maxLength: 16384

failureMode string

Behavior when the external authorization service is unavailable or returns an error. "FailOpen" allows the request to continue. "FailClosed" (default) denies the request.

enum: FailClosed, FailOpen

forwardBody object

Whether to include the HTTP body in the authorization request. If enabled, the request body will be buffered.

maxSize string | integer required

Largest body, in bytes, that will be buffered and sent to the authorization server. If the body size is larger than `maxSize`, then the request will be rejected with a response.

string pattern: ^[+-]?([0-9]+(\.[0-9]*)?|\.[0-9]+)(([KMGTPE]i)|[numkMGTPE]|[eE](\+?0*([0-9]|1[0-8])|-0*[0-9]))?$

string minLength: 1

string maxLength: 32

grpc object

Uses the gRPC External Authorization [protocol](https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto) should be used.

contextExtensions object

Additional arbitrary key-value pairs to send to the authorization server in the `context_extensions` field.

requestMetadata object

Metadata to send to the authorization server. This maps to the `metadata_context.filter_metadata` field of the request, and allows dynamic CEL expressions. If unset, by default the `envoy.filters.http.jwt_authn` key is set if the JWT policy is used as well, for compatibility.

http object

Uses HTTP to connect to the authorization server. The authorization server must return a `200` status code, otherwise the request is considered an authorization failure.

addRequestHeaders object

Additional headers to add to the request to the authorization server. While `allowedRequestHeaders` just passes the original headers through, `addRequestHeaders` allows defining custom headers based on CEL expressions.

allowedRequestHeaders []string

Additional headers from the client request that will be sent to the authorization server. If unset, the following headers are sent by default: `Authorization`.

maxItems: 64

allowedResponseHeaders []string

Headers from the authorization response that will be copied into the request to the backend.

maxItems: 64

body string

Body is a CEL expression that produces the HTTP authorization request body. Strings and bytes are used directly; other values are JSON-encoded.

minLength: 1

maxLength: 16384

path string

Path to send to the authorization server. If unset, this defaults to the original request path. This is a CEL expression, which allows customizing the path based on the incoming request. For example, to add a prefix, use `"/prefix/" + request.path`.

minLength: 1

maxLength: 16384

redirect string

Optional expression that determines a path to redirect to on authorization failure. This is useful to redirect to a sign-in page.

minLength: 1

maxLength: 16384

responseMetadata object

Metadata fields to construct from the authorization response. These will be included under the `extauthz` variable in future CEL expressions. Setting this is useful for things like logging usernames, without needing to include them as headers to the backend, as `allowedResponseHeaders` would.

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

health object

Settings for passive and active health checking.

eviction object

Settings for evicting unhealthy backends.

consecutiveFailures integer

format: int32

minimum: 0

duration string

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

healthThreshold integer

format: int32

minimum: 0

maximum: 100

restoreHealth integer

format: int32

minimum: 0

maximum: 100

unhealthyCondition string

minLength: 1

maxLength: 16384

http object

Settings for managing HTTP requests to the backend

requestTimeout string

Deadline for receiving a response from the backend.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

version string

enum: HTTP1, HTTP2

mcp object

Settings for MCP workloads. This is only applicable when connecting to a `Backend` of type `mcp`.

authentication object

MCP backend-specific authentication rules. This field is deprecated; prefer to use traffic policy `jwtAuthentication.mcp`, which ensures authentication runs before other policies such as transformation and rate limiting.

audiences []string

Allowed audiences that are allowed access. This corresponds to the `aud` claim ([RFC 7519 §4.1.3](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3)). If unset, any audience is allowed.

minItems: 1

maxItems: 64

clientId string

Client ID to use for short-circuiting Dynamic Client Registration. If set, the gateway will not proxy registration requests to the IDP and instead return this client ID.

clientSecretRef object

Reference to a Kubernetes Secret holding the OAuth client secret of the app registration identified by `clientId` (for example Entra ID confidential clients, which require the secret at the token endpoint). The gateway injects it into the token requests it proxies to the provider. Defaults to the `clientSecret` key; override via `clientSecretRef.key`.

group string

API group of the referenced credential; empty selects the core API group

key string

Key in the referenced Secret. If omitted, a location-specific default is used

minLength: 1

maxLength: 253

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

issuer string

IdP that issued the JWT. This corresponds to the `iss` claim ([RFC 7519 §4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1)).

minLength: 1

maxLength: 256

jwks object required

Remote JSON Web Key used to validate the signature of the JWT.

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

cacheDuration string

How long a fetched `jwks` document is used before it is re-fetched from the IdP.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

jwksPath string

Path to the IdP `jwks` endpoint, relative to the root, commonly `".well-known/jwks.json"`.

minLength: 1

maxLength: 1024

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

mode string

Validation mode for JWT authentication.

enum: Optional, Permissive, Strict

provider string

Identity provider to use for authentication.

enum: Auth0, Authentik, Descope, Entra, Keycloak, Okta

resourceMetadata object

Metadata to use for MCP resources.

authorization object

MCP backend authorization. Unlike authorization at the HTTP level, which rejects unauthorized requests with a `403` error, this policy works at the `MCPBackend` level. List operations, such as `list_tools`, will have each item evaluated. Items that do not meet the rule will be filtered. Get or call operations, such as `call_tool`, will evaluate the specific item and reject requests that do not meet the rule.

action string

The effect of this rule when it matches. If unspecified, defaults to `Allow`. `Require` rules are cumulative: all require rules must match.

enum: Allow, Deny, Require

policy object required

The authorization rule to evaluate. * `Allow`: any matching allow rule allows the request. * `Require`: every require rule must match for the request to be allowed. * `Deny`: any matching deny rule denies the request. `Deny` is not recommended because expression failures fail to deny; prefer `Allow` or `Require`. If used, design expressions defensively against evaluation errors. If at least one `Allow` rule is configured, requests are denied unless at least one allow rule matches.

matchExpressions []string required

CEL expressions that must all evaluate to true for the rule to match.

minItems: 1

maxItems: 256

guardrails object

`guardrails` routes selected JSON-RPC methods through a remote policy server.

processors []object required

`processors` is the ordered list of policy processors applied to matched methods. Processors run in the order listed; the first to reject a request short-circuits the chain.

minItems: 1

maxItems: 16

methods object required

`methods` is the allowlist of JSON-RPC methods (e.g. `tools/call`, `tools/list`) routed through this processor, keyed by method name with the phase it runs in. Keys may be exact, a prefix wildcard (`tools/*`), a suffix wildcard (`*/list`), or `*` for all methods; the most specific match wins. Methods matching no key, including unknown ones, bypass this processor.

remote object

`remote` configures a gRPC policy server.

allowedRequestHeaders []string

`allowedRequestHeaders` lists the incoming request headers forwarded to the policy server in `McpRequest.headers`. If empty, all headers and pseudo-headers (`:authority`, `:method`, ...) are forwarded. Matching is case-insensitive.

maxItems: 64

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

disallowedRequestHeaders []string

`disallowedRequestHeaders` lists header names never forwarded to the policy server, even if listed in `allowedRequestHeaders`. Matching is case-insensitive.

maxItems: 64

failureMode string

`failureMode` controls behavior when the policy server is unreachable or returns an error. `FailOpen` allows the request; `FailClosed` (default) denies it.

enum: FailClosed, FailOpen

metadata object

`metadata` is static or CEL-evaluated context surfaced to the policy server as fields of the `metadata_context` google.protobuf.Struct, keyed by config key. Values are CEL expressions.

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

tcp object

Settings for managing TCP connections to the backend

connectTimeout string

Deadline for establishing a connection to the destination.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

keepalive object

Settings for enabling TCP keepalives on the connection.

interval string

Time between keepalive probes. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

retries integer

Maximum number of keepalive probes to send before dropping the connection. If unset, this defaults to 9.

format: int32

minimum: 1

maximum: 64

time string

Time a connection needs to be idle before keepalive probes start being sent. If unset, this defaults to 180s.

pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$

maxLength: 32

tls object

Settings for managing TLS connections to the backend When set, TLS is originated to the backend using the system trusted CA certificates, and SNI is inferred from the destination.

alpnProtocols []string

Application-Layer Protocol Negotiation (`ALPN`) value to use in the TLS handshake. If not present, defaults to `["h2", "http/1.1"]`.

minItems: 1

maxItems: 16

caCertificateRefs []object

maxItems: 1

kind string

Kind of the referenced CA certificate source. Omitted defaults to ConfigMap.

enum: ConfigMap, Secret

name string required

Name of the referenced CA certificate source.

minLength: 1

maxLength: 253

certificateSource string

Source for the gateway's client identity and trust roots (`Inline` default, or `SPIFFE`).

enum: Inline, SPIFFE

insecureSkipVerify string

enum: All, Hostname

keyExchangeGroups []string

Ordered list of key exchange groups for a TLS connection. For example: `X25519_MLKEM768,X25519`.

mtlsCertificateRef []object

maxItems: 1

group string

API group of the referenced credential; empty selects the core API group

kind string

Kind of the referenced credential; empty defaults to `Secret`

name string required

Name of the referenced credential

minLength: 1

maxLength: 253

sni string

Server Name Indicator (`SNI`) to use in the TLS handshake. If unset, the `SNI` is automatically set based on the destination hostname.

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

minLength: 1

maxLength: 253

verifySubjectAltNames []string

Subject Alternative Names (`SAN`) to verify in the server certificate. If not present, the destination hostname is automatically used.

minItems: 1

maxItems: 16

transformation object

Mutates and transforms requests and responses sent to and from the backend.

request object

Request transformation settings.

add []object

Headers to add to the request and what each value should be set to. If there is already a header with these values then append the value as an extra entry.

minItems: 1

maxItems: 16

name string required

The name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

CEL expression that generates the output value for the header.

minLength: 1

maxLength: 16384

body string

HTTP body transformation.

minLength: 1

maxLength: 16384

metadata object

Stores CEL-evaluated values under the `metadata` CEL variable for subsequent policy evaluations. `metadata` is evaluated before header or body transformations.

remove []string

Header names to remove from the request or response.

minItems: 1

maxItems: 16

set []object

Headers to set and the values to use.

minItems: 1

maxItems: 16

name string required

The name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

CEL expression that generates the output value for the header.

minLength: 1

maxLength: 16384

response object

Response transformation settings.

add []object

Headers to add to the request and what each value should be set to. If there is already a header with these values then append the value as an extra entry.

minItems: 1

maxItems: 16

name string required

The name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

CEL expression that generates the output value for the header.

minLength: 1

maxLength: 16384

body string

HTTP body transformation.

minLength: 1

maxLength: 16384

metadata object

Stores CEL-evaluated values under the `metadata` CEL variable for subsequent policy evaluations. `metadata` is evaluated before header or body transformations.

remove []string

Header names to remove from the request or response.

minItems: 1

maxItems: 16

set []object

Headers to set and the values to use.

minItems: 1

maxItems: 16

name string required

The name of the header to add.

pattern: ^:?[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$

minLength: 1

maxLength: 256

value string required

CEL expression that generates the output value for the header.

minLength: 1

maxLength: 16384

tunnel object

Settings for managing tunnel connections to the backend, like `HTTPS_PROXY`

backendRef object

`backendRef` selects a backend for this policy. Mutually exclusive with `url`.

group string

Group of the referent, for example `gateway.networking.k8s.io`. Empty selects the core API group

pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

maxLength: 253

kind string

Kubernetes resource kind of the referent, for example `Service`. Defaults to `Service`

pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$

minLength: 1

maxLength: 63

name string required

Name is the name of the referent.

minLength: 1

maxLength: 253

namespace string

Namespace of the referent. Defaults to the local namespace. A cross-namespace reference requires a ReferenceGrant in the referent namespace

pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

minLength: 1

maxLength: 63

port integer

Destination port number. Required when the referent is a Kubernetes `Service`

format: int32

minimum: 1

maximum: 65535

mode string

How requests are sent through the proxy. Defaults to `Auto`.

enum: Auto, Connect

url string

pattern: ^https?://[^/?#@]+(/[^?#]*)?$

minLength: 1

maxLength: 1024

static object

Static hostname, IP address, or Unix Domain Socket backend.

host string

Host to connect to for TCP backends.

minLength: 1

maxLength: 256

port integer

Port to connect to for TCP backends.

format: int32

minimum: 1

maximum: 65535

unixPath string

Filesystem path to a Unix Domain Socket. The gateway pod must share a volume with the target (e.g., via emptyDir sidecar pattern). Mutually exclusive with host/port.

minLength: 1

status object

Current backend status.

conditions []object

Current condition state for the backend.

maxItems: 8

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

No matches. Try .spec.a2a for an exact path