You want to access the query parameters passed to an HTTP endpoint, such as:
http://example.com/hello-query?name=Nick
Use the msg.req.query
property of the message sent by the HTTP In
node to access the parameters.
[{"id":"b34dd1af.4cb23","type":"template","z":"3045204d.cfbae","name":"page","field":"payload","fieldType":"msg","format":"handlebars","syntax":"mustache","template":"<html>\n <head></head>\n <body>\n <h1>Hello {{req.query.name}}!</h1>\n </body>\n</html>","x":290,"y":180,"wires":[["b828f6a6.47d708"]]},{"id":"1052941d.efad6c","type":"http in","z":"3045204d.cfbae","name":"","url":"/hello-query","method":"get","swaggerDoc":"","x":120,"y":180,"wires":[["b34dd1af.4cb23"]]},{"id":"b828f6a6.47d708","type":"http response","z":"3045204d.cfbae","name":"","x":430,"y":180,"wires":[]}]
[~]$ curl http://localhost:1880/hello-query?name=Nick
<html>
<head></head>
<body>
<h1>Hello Nick!</h1>
</body>
</html>
The msg.req.query
property is an object of key/value pairs for each query parameter.
In the above example, a request to /hello-query?name=Nick&colour=blue
results in the property
containing:
{
"name": "Nick",
"colour": "blue"
}
If there are multiple query parameters with the same name, they will be provided
as an array. For example, /hello-query?colour=blue&colour=red
:
{
"colour": ["blue","red"]
}
Node-RED: Low-code programming for event-driven applications.
Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.
The OpenJS Foundation | Terms of Use | Privacy Policy | OpenJS Foundation Bylaws | Trademark Policy | Trademark List | Cookie Policy