API Reference

Runtime APIs

  • Admin HTTP API

    This HTTP-based API can be used to remotely administer the runtime. It is used by the Node-RED Editor and command-line admin tool.

  • Hooks

    The Hooks API provides a way to insert custom code into certain key points of the runtime operation.

  • Storage

    This API provides a pluggable way to configure where the Node-RED runtime stores data.

  • Logging

    A custom logger can be used to send log events to alternative locations, such as a database.

  • Context Store

    This API provides a pluggable way to store context data outside of the runtime.

  • Library Store

    This API provides a pluggable way to add additional libraries to the Node-RED Import/Export dialog.

Editor APIs

The APIs available in the editor for nodes and plugins to use. This includes a set set of standard UI widgets that can be used within a node’s edit template.

Module APIs

The APIs provided by npm modules that Node-RED is built from. These can be used to embed Node-RED into existing Node.js applications.