docs • api • admin• methods• set flows state

POST /flows/state

Set the runtime state of flows. Note that runtime state of flows is available only if runtimeState value is set to enabled: true in the settings.js file.

Requires permission: flows.write

Headers

Header	Value
`Authorization`	`Bearer [token]` - if authentication is enabled

Arguments

The request body must be a URL-Encoded parameter with the following field:

Field	Description
`state`	Required runtime state of the flow. Can be either `start` or `stop`

Response

Status Code	Reason	Response
`200`	Success	See example response body
`401`	Not authorized	none

{
    "state": "stop"
}

The response object contains the following fields:

Field	Description
`state`	runtime state of the flows. Can be either `start` or `stop`

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.