Skip to main content
Version: 3.10

proxy-rewrite

Description#

The proxy-rewrite Plugin rewrites Upstream proxy information such as scheme, uri and host.

Attributes#

NameTypeRequiredDefaultValid valuesDescription
uristringFalseNew Upstream forwarding address. Value supports Nginx variables. For example, $arg_name.
methodstringFalse["GET", "POST", "PUT", "HEAD", "DELETE", "OPTIONS","MKCOL", "COPY", "MOVE", "PROPFIND", "PROPFIND","LOCK", "UNLOCK", "PATCH", "TRACE"]Rewrites the HTTP method.
regex_uriarray[string]FalseRegular expressions can be used to match the URL from client. If it matches, the URL template is forwarded to the upstream. Otherwise, the URL from the client is forwarded. When both uri and regex_uri are configured, uri has a higher priority. Multiple regular expressions are currently supported for pattern matching, and the plugin will try to match them one by one until they succeed or all fail. For example: ["^/iresty/(. *)/(. *)/(. *)", "/$1-$2-$3", ^/theothers/(. *)/(. *)", "/theothers/$1-$2"], the element with the odd index represents the uri regular expression that matches the request from the client, and the element with the even index represents the uri template that is forwarded upstream upon a successful match. Please note that the length of this value must be an even number.
hoststringFalseNew Upstream host address.
headersobjectFalse
headers.addobjectfalseAppend the new headers. The format is {"name": "value",...}. The values in the header can contain Nginx variables like $remote_addr and $balancer_ip. It also supports referencing the match result of regex_uri as a variable like $1-$2-$3.
headers.setobjectfalseOverwrite the headers. If the header does not exist, it will be added. The format is {"name": "value", ...}. The values in the header can contain Nginx variables like $remote_addr and $balancer_ip. It also supports referencing the match result of regex_uri as a variable like $1-$2-$3. Note that if you would like to set the Host header, use the host attribute instead.
headers.removearrayfalseRemove the headers. The format is ["name", ...].
use_real_request_uri_unsafebooleanFalsefalseUse real_request_uri (original $request_uri in nginx) to bypass URI normalization. Enabling this is considered unsafe as it bypasses all URI normalization steps.

Header Priority#

Header configurations are executed according to the following priorities:

add > remove > set

Enable Plugin#

The example below enables the proxy-rewrite Plugin on a specific Route:

note

You can fetch the admin_key from config.yaml and save to an environment variable with the following command:

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
curl http://127.0.0.1:9180/apisix/admin/routes/1  -H "X-API-KEY: $admin_key" -X PUT -d '
{
"methods": ["GET"],
"uri": "/test/index.html",
"plugins": {
"proxy-rewrite": {
"uri": "/test/home.html",
"host": "iresty.com",
"headers": {
"set": {
"X-Api-Version": "v1",
"X-Api-Engine": "apisix",
"X-Api-useless": ""
},
"add": {
"X-Request-ID": "112233"
},
"remove":[
"X-test"
]
}
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:80": 1
}
}
}'

Example usage#

Once you have enabled the Plugin as mentioned below, you can test the Route:

curl -X GET http://127.0.0.1:9080/test/index.html

Once you send the request, you can check the Upstream access.log for its output:

127.0.0.1 - [26/Sep/2019:10:52:20 +0800] iresty.com GET /test/home.html HTTP/1.1 200 38 - curl/7.29.0 - 0.000 199 107

Delete Plugin#

To remove the proxy-rewrite Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

curl http://127.0.0.1:9180/apisix/admin/routes/1  -H "X-API-KEY: $admin_key" -X PUT -d '
{
"methods": ["GET"],
"uri": "/test/index.html",
"plugins": {},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:80": 1
}
}
}'