Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Node-RED Nodes API

The Nodes API from Node-RED — 3 operation(s) for nodes.

Node-RED Nodes API is one of 6 APIs that Node-RED publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Nodes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 7 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 4.0.0.

Requests are made against a single base URL, http://{host}:{port}.

7 operations 3 paths 0 schemas 1 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0.0
Base URL
http://localhost:1880
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Node-RED Nodes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Nodes 7
GET
/nodes
Get a list of the installed nodes
getNodes → 200
POST
/nodes
Install a new node module
postNodes → 200
GET
/nodes/{module}
Get a node module information
getNodeModule 1 param → 200
PUT
/nodes/{module}
Enable or disable a node module
putNodeModule 1 param → 200
DELETE
/nodes/{module}
Remove a node module
deleteNodeModule 1 param → 204
GET
/nodes/{module}/{set}
Get a node module set information
getNodeModuleSet 2 params → 200
PUT
/nodes/{module}/{set}
Enable or disable a node set
putNodeModuleSet 2 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

node-red-nodes-api-openapi.yml Raw ↑

Other APIs Node-RED publishes across the network.

Node-RED Auth API
Node-RED Diagnostics API
Node-RED Flow API
Node-RED Flows API
Node-RED Settings API