redirect

Property Manager name: Redirect
Behavior version: The v2024-10-21 rule format supports the redirect behavior v1.5.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Respond to the client request with a redirect without contacting the origin. Specify the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. This behavior relies primarily on destinationHostname and destinationPath to manipulate the hostname and path independently.

See also the redirectplus behavior, which allows you to use variables more flexibly to express the redirect's destination.

Option	Type	Description	Requires
`mobileDefaultChoice`	enum	Either specify a default response for mobile browsers, or customize your own.		{"displayType":"enum","options":["DEFAULT","MOBILE"],"tag":"select"}
	`DEFAULT`	Allows all other `responseCode` values.
	`MOBILE`	Allows only a 302 response code.
`destinationProtocol`	enum	Choose the protocol for the redirect URL.		{"displayType":"enum","options":["SAME_AS_REQUEST","HTTP","HTTPS"],"tag":"select"}
	`SAME_AS_REQUEST`	Pass through the original protocol.
	`HTTP`	Use `http`.
	`HTTPS`	Use `https`.
`destinationHostname`	enum	Specify how to change the requested hostname, independently from the pathname.		{"displayType":"enum","options":["SAME_AS_REQUEST","SUBDOMAIN","SIBLING","OTHER"],"tag":"select"}
	`SAME_AS_REQUEST`	Preserves the hostname unchanged.
	`SUBDOMAIN`	Prepends a subdomain from the `destinationHostnameSubdomain` field.
	`SIBLING`	Replaces the leftmost subdomain with the `destinationHostnameSibling` field.
	`OTHER`	Specifies a static domain in the `destinationHostnameOther` field.
`destinationHostnameSubdomain`	string (allows variables)	Specifies a subdomain to prepend to the current hostname. For example, a value of `m` changes `www.example.com` to `m.www.example.com`.	`destinationHostname` is `SUBDOMAIN`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"destinationHostname","op":"eq","value":"SUBDOMAIN"}}
`destinationHostnameSibling`	string (allows variables)	Specifies the subdomain with which to replace to the current hostname's leftmost subdomain. For example, a value of `m` changes `www.example.com` to `m.example.com`.	`destinationHostname` is `SIBLING`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"destinationHostname","op":"eq","value":"SIBLING"}}
`destinationHostnameOther`	string (allows variables)	Specifies the full hostname with which to replace the current hostname.	`destinationHostname` is `OTHER`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"destinationHostname","op":"eq","value":"OTHER"}}
`destinationPath`	enum	Specify how to change the requested pathname, independently from the hostname.		{"displayType":"enum","options":["SAME_AS_REQUEST","PREFIX_REQUEST","OTHER"],"tag":"select"}
	`SAME_AS_REQUEST`	Preserves the current path unchanged.
	`PREFIX_REQUEST`	Prepends a path with the `destinationPathPrefix` field. You also have the option to specify a suffix using `destinationPathSuffix` and `destinationPathSuffixStatus`.
	`OTHER`	Replaces the current path with the `destinationPathOther` field.
`destinationPathPrefix`	string (allows variables)	When `destinationPath` is set to `PREFIX_REQUEST`, this prepends the current path. For example, a value of `/prefix/path` changes `/example/index.html` to `/prefix/path/example/index.html`.	`destinationPath` is `PREFIX_REQUEST`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"destinationPath","op":"eq","value":"PREFIX_REQUEST"}}
`destinationPathSuffixStatus`	enum	When `destinationPath` is set to `PREFIX_REQUEST`, this gives you the option of adding a suffix.	`destinationPath` is `PREFIX_REQUEST`	{"displayType":"enum","options":["NO_SUFFIX","SUFFIX"],"tag":"select"} {"if":{"attribute":"destinationPath","op":"eq","value":"PREFIX_REQUEST"}}
	`NO_SUFFIX`	Specify if you want to preserve the end of the path unchanged.
	`SUFFIX`	The `destinationPathSuffix` provides the value.
`destinationPathSuffix`	string (allows variables)	When `destinationPath` is set to `PREFIX_REQUEST` and `destinationPathSuffixStatus` is set to `SUFFIX`, this specifies the suffix to append to the path.	`destinationPathSuffixStatus` is `SUFFIX`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"destinationPathSuffixStatus","op":"eq","value":"SUFFIX"}}
`destinationPathOther`	string (allows variables)	When `destinationPath` is set to `PREFIX_REQUEST`, this replaces the current path.	`destinationPath` is `OTHER`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"destinationPath","op":"eq","value":"OTHER"}}
`queryString`	boolean	When set to `APPEND`, passes incoming query string parameters as part of the redirect URL. Otherwise set this to `IGNORE`.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`responseCode`	enum	Specify the redirect's response code.		{"displayType":"enum","options":["301","302","303","307"],"tag":"select"}
		Supported values: 301 302 303 307