Node-RED · Schema

Node-RED Flow

Schema for a Node-RED flow exported via the Admin API.

Self-HostedWorkflow AutomationFlow-Based ProgrammingIoT

Properties

Name	Type	Description
id	string	Unique identifier for the flow node
type	string	Node type (tab, inject, function, etc.)
label	string	Human-readable label for the flow tab
name	string	Node name within the flow
disabled	boolean	Whether the flow is disabled
info	string	Description / documentation for the flow
env	array	Environment variables scoped to the flow
wires	array	Output wiring connections to other nodes
z	string	Identifier of the parent tab
x	number
y	number

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/node-red/refs/heads/main/json-schema/node-red-flow-schema.json",
  "title": "Node-RED Flow",
  "description": "Schema for a Node-RED flow exported via the Admin API.",
  "type": "object",
  "required": ["id", "type"],
  "properties": {
    "id": { "type": "string", "description": "Unique identifier for the flow node" },
    "type": { "type": "string", "description": "Node type (tab, inject, function, etc.)" },
    "label": { "type": "string", "description": "Human-readable label for the flow tab" },
    "name": { "type": "string", "description": "Node name within the flow" },
    "disabled": { "type": "boolean", "description": "Whether the flow is disabled" },
    "info": { "type": "string", "description": "Description / documentation for the flow" },
    "env": {
      "type": "array",
      "description": "Environment variables scoped to the flow",
      "items": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "value": { "type": "string" },
          "type": { "type": "string" }
        }
      }
    },
    "wires": {
      "type": "array",
      "description": "Output wiring connections to other nodes",
      "items": {
        "type": "array",
        "items": { "type": "string" }
      }
    },
    "z": { "type": "string", "description": "Identifier of the parent tab" },
    "x": { "type": "number" },
    "y": { "type": "number" }
  }
}