Skip to main content
Version: 2.11




The proxy-rewrite is an upstream proxy information rewriting plugin, which supports the rewriting of information such as scheme, uri, and host.


schemestringoptional"http"["http", "https"]Upstream new schema forwarding protocol. This option is deprecated. It's recommended to set the proxy scheme in the Upstream object's scheme field instead.
uristringoptionalUpstream new uri forwarding address. Supports the use of Nginx variables. Variables must start with $, such as $arg_name.
methodstringoptional["GET", "POST", "PUT", "HEAD", "DELETE", "OPTIONS","MKCOL", "COPY", "MOVE", "PROPFIND", "PROPFIND","LOCK", "UNLOCK", "PATCH", "TRACE"]rewrite the HTTP method.
regex_uriarray[string]optionalUpstream new uri forwarding address. Use regular expression to match URL from client, when the match is successful, the URL template will be forwarded upstream. If the match is not successful, the URL from the client will be forwarded to the upstream. When uri and regex_uri are both exist, uri is used first. For example: [" ^/iresty/(.)/(.)/(.*)", "/$1-$2-$3"], the first element represents the matching regular expression and the second element represents the URL template that is forwarded to the upstream.
hoststringoptionalUpstream new host forwarding address, example
headersobjectoptionalForward to the new headers of the upstream, can set up multiple. If it exists, will rewrite the header, otherwise will add the header. You can set the corresponding value to an empty string to remove a header. Support the use of Nginx variables. Need to start with $, such as client_addr: $remote_addr: it means that the request header client_addr is the client IP.

How To Enable#

Here's an example, enable the proxy-rewrite plugin on the specified route:

curl  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/test/index.html",    "plugins": {        "proxy-rewrite": {            "uri": "/test/home.html",            "scheme": "http",            "host": "",            "headers": {                "X-Api-Version": "v1",                "X-Api-Engine": "apisix",                "X-Api-useless": ""            }        }    },    "upstream": {        "type": "roundrobin",        "nodes": {            "": 1        }    }}'

Test Plugin#

Testing based on the above examples :

curl -X GET

Send the request and see upstream `access.log', if the output information is consistent with the configuration : - [26/Sep/2019:10:52:20 +0800] GET /test/home.html HTTP/1.1 200 38 - curl/7.29.0 - 0.000 199 107

This means that the proxy-rewrite plugin is in effect.

Disable Plugin#

When you want to disable the proxy-rewrite plugin, it is very simple, you can delete the corresponding json configuration in the plugin configuration, no need to restart the service, it will take effect immediately :

curl  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/test/index.html",    "plugins": {},    "upstream": {        "type": "roundrobin",        "nodes": {            "": 1        }    }}'

The proxy-rewrite plugin has been disabled now. It works for other plugins.