Avoid nginx escaping query parameters on proxy_pass

Question

I to proxy /api on a domain, I have this location block.

location ^~ /api/ {
    rewrite_log on;
    rewrite ^/api/(.*) /$1$is_args$args break;
    proxy_pass http://127.0.0.1:1337;
}

It works fine as long as the URLs do not have query parameters, but as soon as they do, I get errors on the upstream server like these Could not find path: /records%3fname=hoegh.io

The %3f in question here is an URL encoded ?, and since it's URL encoded, the upstream server does not recognize it. That might be retarded, but I was hoping it was possible to get nginx to handle this correctly (ie. not escape the URL before passing it to the proxy).

Any ideas?

Did the solution provided work for you? Please accept the answer — qodeninja, Nov 27 '13 at 19:54
"retarded" is an unfortunate and derogatory choice of word here. — apotek, Nov 07 '18 at 00:29

Wolph · Answer 1 · 2013-10-06T15:50:07.233

1

Have you tried this instead? It's generally not needed to add the query string as Nginx adds it automatically:

rewrite ^/api/(.*) /$1? break;

edited Oct 06 '13 at 15:50

answered Oct 06 '13 at 11:01

Wolph

78,177
11
137
148

I did have that earlier, but then it seemed the query string wasn't passed along at all. – mikl Oct 06 '13 at 13:26
Sorry, my bad. I forgot to type the `?` at the end of the redirect string – Wolph Oct 06 '13 at 15:50

score 1 · Accepted Answer · answered Oct 28 '16 at 19:01

You don't need to do anything. $args is passed along automatically.

If you wish to modify the $args that are passed you have to override.

set $args "foo=bar";

for instance.

Working solution should go as follows:

location ^~ /api/ {
    rewrite_log on;
    rewrite ^/api/(.*) /$1 break;
    proxy_pass http://127.0.0.1:1337;
}

Avoid nginx escaping query parameters on proxy_pass

2 Answers2

Linked