HTTP redirect

The Redirect module exposes an unauthenticated HTTP GET route that redirects requests to another local or external location.

Configuration

Note

Module name: Redirect

The module also exposes the alias Redir; Redirect is the name used by the platform tests and examples.

Properties

Name	Description	Default	Mandatory
http_context	Base HTTP context that is combined with path.	"/"	false
path	GET route to redirect. End the value with /* to preserve and append the remaining request path to location.	"/"	false
location	Value returned in the HTTP Location header.	"/"	false
status	HTTP redirect status code.	303	false

Example

{
  "name": "Redirect",
  "config": {
    "http_context": "/old",
    "path": "/*",
    "location": "/new/",
    "status": 303
  }
}

With this configuration, /old/account redirects to /new/account.

Caution

The wildcard source and target must not overlap, and location must not end with /*. Access rejects either configuration during module startup.