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 Flows API

The Flows API from Node-RED — 2 operation(s) for flows.

Node-RED Flows 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 Flows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 4 operations across 2 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}.

4 operations 2 paths 0 schemas 2 GET2 POST

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 Flows API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Flows 4
GET
/flows
Get the active flow configuration
getFlows → 200
POST
/flows
Set the active flow configuration
postFlows → 204
GET
/flows/state
Get the active flow runtime state
getFlowsState → 200
POST
/flows/state
Set the active flow runtime state
postFlowsState → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

node-red-flows-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 Nodes API
Node-RED Settings API