Sign in
Routes

Get a Route

Get a Route using ID or name.

get/{workspace}/routes/{RouteIdOrName}#RouteExpression

Path parameters

workspacestring required
Example:team-payments

The name of the workspace

Response

Successfully fetched Route

created_atinteger nullable

Unix epoch when the resource was created.

expressionstring nullable

Use Router Expression to perform route match. This option is only available when router_flavor is set to expressions.

https_redirect_status_code301 | 302 | 307 | 308 | 426 nullable

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.

idstring nullable

A string representing a UUID (universally unique identifier).

namestring nullable

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

path_handling'v0' | 'v1' nullable

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.

preserve_hostboolean nullable

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.

priorityinteger nullable

A number used to specify the matching order for expression routes. The higher the priority, the sooner an route will be evaluated. This field is ignored unless expression field is set.

protocolsstring[] nullable

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.

request_bufferingboolean nullable

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.

response_bufferingboolean nullable

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.

strip_pathboolean nullable

When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.

tagsstring[] nullable

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

updated_atinteger nullable

Unix epoch when the resource was last updated.

Changes

Changed in 2 of the 11 revisions of this API.2

Of the 11 revisions, 1 has no diff computed.