POST /flows

Set the active flow configuration.

Requires permission: flows.write

Headers

The Node-RED-Deployment-Type header is used to define what type of deployment is performed.

• 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)

Arguments

The format of the request body will depend on the Node-RED API version being used:

v1 - array of node objects

[
  {
    "type": "tab",
    "id": "396c2376.c693dc",
    "label": "Sheet 1"
  }
]

v2 - flow response object

The rev property, if provided, should reflect the revision of flows that was returned by GET /flows.

{
    "rev": "abc-123",
    "flows": [
      {
        "type": "tab",
        "id": "396c2376.c693dc",
        "label": "Sheet 1"
      }
    ]
}

Response

If v1 of the API is being used, a successful request contains no response body.

If 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 the 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 the request.

On a successful request, the response provides the new rev value:

{
    "rev": "def-456",
}

Note: the rev property is a string, but no other assumptions should be made as to its format.