Nginx remove substring and add as url param

Question

This is related to this question, but the answer did not work for me.

I need to turn this: /api/batch.json?param=1

into /batch?param=1&format=json

Nginx location:

location /api/batch {
   proxy_set_header   X-Real-IP        $remote_addr;
   proxy_set_header   Host             $http_host;
   proxy_pass         http://localhost:8000/batch;
}

How can I do this?

Try: `rewrite ^/api(/batch)\.(json)$ $1?format=$2 break;` inside the `location` block. — Richard Smith, Nov 21 '19 at 12:03
Brilliant, works like a charm. You are welcome to post it as an answer — Werner Raath, Nov 21 '19 at 12:17

score 1 · Accepted Answer · answered Nov 21 '19 at 13:37

Use rewrite...break to change the URI within a location before passing it upstream using proxy_pass.

For example:

location /api/batch {
    ...
    rewrite ^/api(/batch)\.(json)$ $1?format=$2 break;
    proxy_pass  ...;
}

The rewrite directive will automatically append the original parameters (if any) unless the replacement string ends with a ?. See this document for details.

Nginx remove substring and add as url param

1 Answers1