HttpRouteRedirectResponse

data class HttpRouteRedirectResponse(val hostRedirect: String, val httpsRedirect: Boolean, val pathRedirect: String, val portRedirect: Int, val prefixRewrite: String, val responseCode: String, val stripQuery: Boolean)

The specification for redirecting traffic.

Constructors

Link copied to clipboard
fun HttpRouteRedirectResponse(hostRedirect: String, httpsRedirect: Boolean, pathRedirect: String, portRedirect: Int, prefixRewrite: String, responseCode: String, stripQuery: Boolean)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The host that will be used in the redirect response instead of the one that was supplied in the request.

Link copied to clipboard

If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. The default is set to false.

Link copied to clipboard

The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

Link copied to clipboard

The port that will be used in the redirected request instead of the one that was supplied in the request.

Link copied to clipboard

Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.

Link copied to clipboard

The HTTP Status code to use for the redirect.

Link copied to clipboard

if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.