docs • api • admin• methods• update flow

PUT /flow/:id

Update a flow in the active configuration. A flow is represented as a tab within the editor.

All nodes in the existing flow are stopped before the new flow configuration is started.

Requires permission: flows.write

Headers

Header	Value
`Authorization`	`Bearer [token]` - if authentication is enabled
`Content-type`	`application/json`

Arguments

Path Component	Description
`id`	The id of the flow to update, or `global`

The request body must be a single flow configuration object.

For a normal flow:

{
  "id": "91ad451.f6e52b8",
  "label": "Sheet 1",
  "nodes": [ ],
  "configs": [ ]
}

For the global flow:

{
  "id": "global",
  "configs": [ ],
  "subflows": [ ]
}

Response

Status Code	Reason	Response
`204`	Success	none
`400`	Bad request	An Error response
`401`	Not authorized	none

Returns the id of the flow.

{"id":"5a04dce3.a5fb24"}

Node-RED: Low-code programming for event-driven applications.

Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.