Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RedirectUri

An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.

*NOTE:** The Load Balancing service cannot automatically detect or avoid infinite redirects. Be sure to provide meaningful, complete, and correct field values. If any component field of this object has no value, the system retains the value from the incoming HTTP request URI.

For example, if you specify only the protocol field {@code https}, and the incoming request URI is {@code http://example.com:8080}, the resulting runtime redirect URI is {@code https://example.com:8080}. The system retains the host and port from the incoming URI and does not automatically change the port setting from {@code 8080} to {@code 443}.

Be sure to configure valid percent-encoding (URL encoding) when needed.

In addition to static string values, you can use the following tokens to construct the redirect URI. These tokens extract values from the incoming HTTP request URI.

{protocol} : The protocol from the incoming HTTP request URI. * {host} : The domain name from the incoming HTTP request URI. * {port} : The port from the incoming HTTP request URI. * {path} : The path from the incoming HTTP request URI. * {query} : The query string from the incoming HTTP request URI.

The tokens are case sensitive. For example, {@code {host}} is a valid token, but {@code {HOST}} is not.

You can retain the literal characters of a token when you specify values for the path and query properties of the redirect URI. Use a backslash (\\\\) as the escape character for the \\\\, {, and } characters. For example, if the incoming HTTP request URI is {@code /video}, the path property value:

{@code /example{path}123\\{path\\}}

appears in the constructed redirect URI as:

{@code /example/video123{path}}

Properties

Functions

Properties

Optional host

host: undefined | string

The valid domain name (hostname) or IP address to use in the redirect URI.

When this value is null, not set, or set to {@code {host}}, the service preserves the original domain name from the incoming HTTP request URI.

All RedirectUri tokens are valid for this property. You can use any token more than once.

Curly braces are valid in this property only to surround tokens, such as {@code {host}}

Examples:

**example.com** appears as {@code example.com} in the redirect URI.

**in{host}** appears as {@code inexample.com} in the redirect URI if {@code example.com} is the hostname in the incoming HTTP request URI.

**{port}{host}** appears as {@code 8081example.com} in the redirect URI if {@code example.com} is the hostname and the port is {@code 8081} in the incoming HTTP request URI.

Optional path

path: undefined | string

The HTTP URI path to use in the redirect URI.

When this value is null, not set, or set to {@code {path}}, the service preserves the original path from the incoming HTTP request URI. To omit the path from the redirect URI, set this value to an empty string, \"\".

All RedirectUri tokens are valid for this property. You can use any token more than once.

The path string must begin with {@code /} if it does not begin with the {@code {path}} token.

Examples:

__/example/video/123__ appears as {@code /example/video/123} in the redirect URI.

__/example{path}__ appears as {@code /example/video/123} in the redirect URI if {@code /video/123} is the path in the incoming HTTP request URI.

__{path}/123__ appears as {@code /example/video/123} in the redirect URI if {@code /example/video} is the path in the incoming HTTP request URI.

__{path}123__ appears as {@code /example/video123} in the redirect URI if {@code /example/video} is the path in the incoming HTTP request URI.

__/{host}/123__ appears as {@code /example.com/123} in the redirect URI if {@code example.com} is the hostname in the incoming HTTP request URI.

__/{host}/{port}__ appears as {@code /example.com/123} in the redirect URI if {@code example.com} is the hostname and {@code 123} is the port in the incoming HTTP request URI.

__/{query}__ appears as {@code /lang=en} in the redirect URI if the query is {@code lang=en} in the incoming HTTP request URI.

Optional port

port: undefined | number

The communication port to use in the redirect URI.

Valid values include integers from 1 to 65535.

When this value is null, the service preserves the original port from the incoming HTTP request URI.

Example: {@code 8081} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional protocol

protocol: undefined | string

The HTTP protocol to use in the redirect URI.

When this value is null, not set, or set to {@code {protocol}}, the service preserves the original protocol from the incoming HTTP request URI. Allowed values are:

HTTP * HTTPS * {protocol}

{@code {protocol}} is the only valid token for this property. It can appear only once in the value string.

Example: {@code HTTPS}

Optional query

query: undefined | string

The query string to use in the redirect URI.

When this value is null, not set, or set to {@code {query}}, the service preserves the original query parameters from the incoming HTTP request URI.

All {@code RedirectUri} tokens are valid for this property. You can use any token more than once.

If the query string does not begin with the {@code {query}} token, it must begin with the question mark (?) character.

You can specify multiple query parameters as a single string. Separate each query parameter with an ampersand (&) character. To omit all incoming query parameters from the redirect URI, set this value to an empty string, \"\".

If the specified query string results in a redirect URI ending with {@code ?} or {@code &}, the last character is truncated. For example, if the incoming URI is {@code http://host.com:8080/documents} and the query property value is {@code ?lang=en&{query}}, the redirect URI is {@code http://host.com:8080/documents?lang=en}. The system truncates the final ampersand (&) because the incoming URI included no value to replace the {query} token.

Examples: * **lang=en&time_zone=PST** appears as {@code lang=en&time_zone=PST} in the redirect URI.

**{query}** appears as {@code lang=en&time_zone=PST} in the redirect URI if {@code lang=en&time_zone=PST} is the query string in the incoming HTTP request. If the incoming HTTP request has no query parameters, the {@code {query}} token renders as an empty string.

**lang=en&{query}&time_zone=PST** appears as {@code lang=en&country=us&time_zone=PST} in the redirect URI if {@code country=us} is the query string in the incoming HTTP request. If the incoming HTTP request has no query parameters, this value renders as {@code lang=en&time_zone=PST}.

**protocol={protocol}&hostname={host}** appears as {@code protocol=http&hostname=example.com} in the redirect URI if the protocol is {@code HTTP} and the hostname is {@code example.com} in the incoming HTTP request.

**port={port}&hostname={host}** appears as {@code port=8080&hostname=example.com} in the redirect URI if the port is {@code 8080} and the hostname is {@code example.com} in the incoming HTTP request URI.

Functions

getDeserializedJsonObj

getJsonObj