TRtremor-rs
flows

change the status of a flow

Changed on
patch/v1/flows/{flow-id}

Request

  • Base URL
    http://localhost:9898
  • Auth
    none declared

Request body

status'running' | 'paused' required

Valid statusses flows and connectors can be switched to

Example request

{
  "status": "paused"
}

Response

The new status of the flow after applying the patch

aliasstring required

Alias of the flow

status'initializing' | 'running' | 'paused' | 'draining' | 'stopped' | 'failed' required

runtime status of a flow or connector instance

connectorsstring[] required

aliases of connectors in the flow

Example response

{
  "alias": "kafka",
  "status": "initializing",
  "connectors": [
    "consumer1",
    "metrics",
    "out"
  ]
}

Changes