Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-178913.4 KB
flows
connectors

Get detailed information on the connector 'connector-id' in the flow 'flow-id'.

get/v1/flows/{flow-id}/connectors/{connector-id}

Response

Connector information for 'connector-id' within flow 'flow-id'

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"
      }
    ]
  }
}