The name of the Route.
Optionally add tags to the route
A list of domain names that match this Route. For example: example.com. At least one of hosts, paths, or methods must be set.
A list of paths that match this Route. For example: /my-path. At least one
of hosts
, paths
, or methods
must be
set.
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.
Field values format example: x-some-header:foo,bar
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. Defaults to 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). Defaults to 0
.
A list of HTTP methods that match this Route. At least one of
hosts
, paths
, or methods
must be
set.
When matching a Route via one of the paths
, strip the
matching prefix from the upstream request URL.
When matching a Route via one of the hosts
domain names, use
the request Host
header in the upstream request headers. By
default set to false
, and the upstream Host header will be
that of the Service's host
A list of the protocols this Route should allow. By default it is
["http", "https"]
, which means that the Route accepts both.
When set to ["https"]
, HTTP requests are answered with a
request to upgrade to HTTPS.
A list of SNIs that match this Route when using stream routing. When using
tcp
or tls
protocols, at least one of
snis
, sources
, or destinations
must
be set.
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”. When using tcp
or
tls
protocols, at least one of snis
,
sources
, or destinations
must be set.
The field expects values with ip:port format. ex:
192.168.1.2:3000
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”. When using
tcp
or tls
protocols, at least one of
snis
, sources
, or destinations
must
be set.
The field expects values with ip:port format. ex:
192.168.1.2:3000