Skip to main content

Redirect Plugin Reference

FieldTypeDefaultOptionalLimitationsDescription
Modestring-NoOptional Values: Replace, Regex SubstituteSpecify the running mode.
Encode URIbooleanfalseYesWhether encode the URI in Location header.
Append Query StringbooleanfalseYesWhether append the querystring in Location header.
Redirect Codeinteger302YesOptional Values: 301, 302, 303, 307, 308HTTP redirection code.

Replace Mode

FieldTypeDefaultOptionalLimitationsDescription
Redirect Tostring-NoThe redirection URL (Location header).

Regex Substitute Mode

FieldTypeDefaultOptionalLimitationsDescription
Match Patternstring-NoMatch pattern for the current API URL. Note if the API doesn't match the pattern, the redirection won't happen.
Substitutionstring-NoThe new URL (Location header) construction template. Users can use regex capture group (e.g., $1) to reference some match parts from the Match Pattern.

API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IRed Herring

Copyright © APISEVEN Ltd. 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation