Set the active flow configuration.
||(Since 0.15.0) The api version being used. Defaults to
Node-RED-Deployment-Type header is used to define what type of deployment
full- all existing nodes are stopped before the new configuration is started. This is the default behaviour if the header is not provided.
nodes- only nodes that have been modified are stopped before the new configuration is applied.
flows- only flows that contain modified nodes are stopped before the new configuration is applied.
reload- the flows are reloaded from storage and all nodes are restarted (since Node-RED 0.12.2)
The format of the request body will depend on the Node-RED API version being used:
v1- array of node objects
v2- flow response object
rev property, if provided, should reflect the revision of flows that was returned by
There are two ways to provide credentials with this request. The individual node
objects in the
flows array can contain a
credentials property containing the
credentials for that node.
Alternatively, the top level object can include a
credentials property that has
credentials for individual nodes, or a complete encrypted set.
Inline node credentials :
Separate node credentials :
Encrypted node credentials:
||Invalid API version||An Error response|
||Version mismatch||An Error response. See below.|
v1 of the API is being used, a successful request contains no response body.
v2 of the API is being used, the request should include
rev property that
is set to the latest
rev value known to the requestor. If this value matches
rev value of the active flows in the runtime, the request will succeed.
If it does not match, this indicates the runtime is using a newer version of flows
and the request is rejected with a
409 status code. This allows the requestor to
resolve any differences and resubmit the request.
If the requestor wishes to force deploy, the
rev property should be omitted from
On a successful request, the response provides the new
rev property is a string, but no other assumptions should be made
as to its format.