TRtremor-rs
flows
connectors

change the status of a connector

Changed on
patch/v1/flows/{flow-id}/connectors/{connector-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 connector after the patch

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

runtime status of a flow or connector instance

connectivity'connected' | 'disconnected' required

denoting whether this connector is connected to its external system

pipelinesobject required

Example response

{
  "alias": "foo",
  "status": "running",
  "connectivity": "connected",
  "pipelines": {
    "out": [
      {
        "alias": "pass",
        "port": "in"
      }
    ]
  }
}

Changes

  • b73c19450409Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/yaml for the response with the status

    • info

      added the non-success response with the status

  • 0456ca3a6da1Revision changes
    • info

      endpoint added