Understanding the Node-RED Runtime API

Published: | by Julian Knight Reading time ~1 min.
📖 Kb | 📎 Development | 🔖 node-red

Node-RED exposes an extensive API at runtime. While most of this is not available within your flows, much of it is available to custom nodes. Unfortunately, documentation for the API lags behind development. This page documents some of the key things I’ve learned about the API, what it does and how it works.

The official API documentation is here in the Node-RED docs.

The API is accessed via the RED object.

Available in Function Nodes 🔗︎

  • RED.util.xxxx

Available in Custom Nodes 🔗︎

RED.util. 🔗︎

comments powered by Disqus