View our GitHub

Please visit sails-docs on GitHub to view documentation on your mobile device.

Edit Page


An object containing parameter values parsed from the URL path.

For example if you have the route /user/:name, then the "name" from the URL path wil be available as This object defaults to {}.




  • When a route address is defined using a regular expression, each capture group match from the regex is available as req.params[0], req.params[1], etc.This strategy is also applied to unnamed wild-card matches in string routes such as /file/*.

Is something missing?

If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails-docs repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.


We wrote a book!

Get early access to the book
with promotion code: mcneildoc

Get the Book