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

The Flow API from Node-RED — 2 operation(s) for flow.

Node-RED Flow 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 Flow. 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 1 DELETE1 GET1 POST1 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 Flow 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 — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Flow 4
POST
/flow
Add a flow to the active configuration
postFlow → 200
GET
/flow/{id}
Get an individual flow configuration
getFlowById 1 param → 200
PUT
/flow/{id}
Update an individual flow configuration
putFlowById 1 param → 200
DELETE
/flow/{id}
Delete an individual flow configuration
deleteFlowById 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Node-RED publishes across the network.

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