The service name.

The number of retries to execute upon failure to proxy. Default:5.

The protocol used to communicate with the upstream. Accepted values are: grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws , wss . Default: http.

The host of the upstream server. Note that the host value is case sensitive.

The upstream server port. Default: 80.

The path to be used in requests to the upstream server.

The timeout in milliseconds for establishing a connection to the upstream server. Default: 60000.

The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: 60000.

The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: 60000.

An optional set of strings associated with the service for grouping and filtering.

Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is client_certificate.id=<client_certificate id>. With JSON, use client_certificate:{id:<client_certificate id>}.

Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.

Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected. Default: null.

Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server’s TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515. With JSON, use an Array.

The service name.

The number of retries to execute upon failure to proxy. Default:5.

The protocol used to communicate with the upstream. Accepted values are: grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws , wss . Default: http.

The host of the upstream server. Note that the host value is case sensitive.

The upstream server port. Default: 80.

The path to be used in requests to the upstream server.

The timeout in milliseconds for establishing a connection to the upstream server. Default: 60000.

The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: 60000.

The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: 60000.

An optional set of strings associated with the service for grouping and filtering.

Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is client_certificate.id=<client_certificate id>. With JSON, use client_certificate:{id:<client_certificate id>}.

Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.

Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected. Default: null.

Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server’s TLS certificate. If set to null when Nginx default is respected. With form-encoded, the notation is ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515. With JSON, use an Array.

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”.

An array of the protocols this route should allow

A list of HTTP methods that match this route.

A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is hosts[]=example.com&hosts[]=foo.test. With JSON, use an Array.

A list of paths that match this route. With form-encoded, the notation is paths[]=/foo&paths[]=/bar. With JSON, use an array. The path can be a regular expression, or a plain text pattern.

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.

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. Accepted values are: 426, 301, 302, 307, 308. Default: 426.

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.

When matching a route via one of the paths, strip the matching prefix from the upstream request URL. Default: true.

Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are: v0, v1. Default: v0.

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.

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.

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”.

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”.

An optional set of strings associated with the route for grouping and filtering.

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”.

An array of the protocols this route should allow

A list of HTTP methods that match this route.

A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is hosts[]=example.com&hosts[]=foo.test. With JSON, use an Array.

A list of paths that match this route. With form-encoded, the notation is paths[]=/foo&paths[]=/bar. With JSON, use an array. The path can be a regular expression, or a plain text pattern.

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.

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. Accepted values are: 426, 301, 302, 307, 308. Default: 426.

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.

When matching a route via one of the paths, strip the matching prefix from the upstream request URL. Default: true.

Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are: v0, v1. Default: v0.

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.

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.

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”.

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”.

An optional set of strings associated with the route for grouping and filtering.

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”.

An array of the protocols this route should allow

A list of HTTP methods that match this route.

A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is hosts[]=example.com&hosts[]=foo.test. With JSON, use an Array.

A list of paths that match this route. With form-encoded, the notation is paths[]=/foo&paths[]=/bar. With JSON, use an array. The path can be a regular expression, or a plain text pattern.

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.

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. Accepted values are: 426, 301, 302, 307, 308. Default: 426.

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.

When matching a route via one of the paths, strip the matching prefix from the upstream request URL. Default: true.

Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are: v0, v1. Default: v0.

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.

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.

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”.

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”.

An optional set of strings associated with the route for grouping and filtering.

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”.

An array of the protocols this route should allow

A list of HTTP methods that match this route.

A list of domain names that match this route. Note that the hosts value is case sensitive. With form-encoded, the notation is hosts[]=example.com&hosts[]=foo.test. With JSON, use an Array.

A list of paths that match this route. With form-encoded, the notation is paths[]=/foo&paths[]=/bar. With JSON, use an array. The path can be a regular expression, or a plain text pattern.

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.

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. Accepted values are: 426, 301, 302, 307, 308. Default: 426.

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.

When matching a route via one of the paths, strip the matching prefix from the upstream request URL. Default: true.

Controls how the service path, route path and requested path are combined when sending a request to the upstream. Accepted values are: v0, v1. Default: v0.

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.

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.

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”.

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”.

An optional set of strings associated with the route for grouping and filtering.

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used. Default: null.With form-encoded, the notation is route.id=<route id> or route.name=<route name>. With JSON, use route:{id:<route id>} or route:{name:<route name>}.

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.

The Plugin instance name.

The configuration properties for the Plugin

A list of the request protocols that will trigger this plugin.

Whether the plugin is applied. Default: true.

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used. Default: null.With form-encoded, the notation is route.id=<route id> or route.name=<route name>. With JSON, use route:{id:<route id>} or route:{name:<route name>}.

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.

The Plugin instance name.

The configuration properties for the Plugin

A list of the request protocols that will trigger this plugin.