v24

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2023-10-2712636.3 KB
flows

Start a flow

Initiates the flow's integration process by publishing an appropriate event to the event bus. Requires the 'flows.control' permission.

post/flows/{id}/start

Path parameters

idstring string required

ID of flow to start, must be a valid MongoDB ID.

Response

Returns the id and new status of the flow

metaobject

Example response

{
  "data": {
    "id": "5c99ec7e5ed40d3e7512cffa",
    "status": "starting"
  }
}