AIGatewayRedisAzureAuthentication
objectAzure specific configs for connecting to a Cloud Provider’s redis instance.
Allowed values:azure
Azure Client ID.
This field is referenceable.
This field is encrypted.
Azure Client Secret.
This field is referenceable.
This field is encrypted.
Azure Tenant ID.
This field is referenceable.
This field is encrypted.
AIGatewayRedisGCPAuthentication
objectGCP specific configs for connecting to a Cloud Provider’s redis instance.
Allowed values:gcp
GCP Service Account JSON.
This field is referenceable.
This field is encrypted.
AIGatewayRedisCloudConfiguration
objectConfig for connecting to a Cloud Provider’s Redis instance.
One OfAuth related config for connecting to a Cloud Provider’s Redis instance.
AWS specific configs for connecting to a Cloud Provider’s redis instance.
Show Child Parameters
Cluster configuration for the Redis connection.
Show Child Parameters
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
Default:2000
>= 0<= 2147483646
If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
Default:false
Database to use for the Redis connection when using the redis strategy
Default:0
A string representing a host name, such as example.com.
This field is referenceable.
Default:127.0.0.1
Keepalive configuration for the Redis connection.
Show Child Parameters
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
This field is referenceable.
This field is encrypted.
An integer representing a port number between 0 and 65535, inclusive.
This field is referenceable.
Default:6379
>= 0<= 65535
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
Default:2000
>= 0<= 2147483646
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
Default:2000
>= 0<= 2147483646
Configuration for Redis Sentinel.
Show Child Parameters
A string representing an SNI (server name indication) value for TLS.
This field is referenceable.
If set to true, uses SSL to connect to Redis.
Default:false
If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
Default:true
Username to use for Redis connections. If undefined, ACL authentication won’t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
This field is referenceable.
AIGatewayRouteConfig
objectConfiguration for an AI Gateway route.
A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields ip (optionally in CIDR range notation) and/or port.
Example:{"ip":"10.1.0.0/16","port":1234}
Show Child Parameters
One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.
Example:{"version":["v1","v2"]}
A list of domain names that match this route. Note that the hosts value is case sensitive.
Example:foo.example.com
The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the route is configured to only accept the https protocol.
Default:426
Example:56c4566c-14cc-4132-9011-4139fcbbe50a
A list of HTTP methods that match this route.
The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named test and Test.
Controls how the service path, route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.
Default:v0
A list of paths that match this route.
When matching a route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the service’s host.
Default:false
An array of the protocols this route should allow. See the route Object section for a list of accepted protocols. When set to only https, HTTP requests are answered with an upgrade error. When set to only http, HTTPS requests are answered with an error.
Default:http, https
A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).
Default:0
Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.
Default:true
Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.
Default:true
The service this route is associated to. This is where the route proxies traffic to.
Show Child Parameters
A list of SNIs that match this route when using stream routing.
A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields ip (optionally in CIDR range notation) and/or port.
Example:{"ip":"10.1.0.0/16","port":1234}
Show Child Parameters
When matching a route via one of the paths, strip the matching prefix from the upstream request URL.
Default:true
An optional set of strings associated with the route for grouping and filtering.
AIGatewayLoggingConfig
objectConfiguration for AI Gateway logging.
Default:false
Default:false