Skip to Content
OpenETL
ReferenceAPIPipeline Service

List pipelines

GET
/v1/workspaces/{workspace}/pipelines

Path Parameters

workspace*string

The workspace id.

Query Parameters

pageSize?integer
Formatint32
pageToken?string

Response Body

OK

application/json
  1. response
pipelines?array<>
nextPageToken?string
Example Request
curl -X GET 'http://localhost:8080/v1/workspaces/string/pipelines'
Example Response
{  "pipelines": [    {      "name": "string",      "spec": {        "mode": "PIPELINE_MODE_UNSPECIFIED",        "schedule": {          "every": "string",          "cron": "string",          "jitter": "string"        },        "dataPlane": "string",        "source": {          "ref": "string",          "streams": [            {              "name": "string",              "sync": "SYNC_MODE_UNSPECIFIED",              "cursor": "string",              "columns": {                "property1": {                  "type": "COLUMN_TYPE_UNSPECIFIED",                  "held": {                    "mode": "HELD_MODE_UNSPECIFIED",                    "value": "string"                  }                },                "property2": {                  "type": "COLUMN_TYPE_UNSPECIFIED",                  "held": {                    "mode": "HELD_MODE_UNSPECIFIED",                    "value": "string"                  }                }              },              "timestamps": "TIMESTAMP_UNIT_UNSPECIFIED",              "require": "DELIVERY_LEVEL_UNSPECIFIED",              "collapse": true,              "quarantine": "QUARANTINE_SCOPE_UNSPECIFIED",              "held": {                "mode": "HELD_MODE_UNSPECIFIED",                "value": "string"              },              "groups": [                {                  "columns": [                    "string"                  ]                }              ],              "typeChanges": "TYPE_CHANGES_UNSPECIFIED"            }          ]        },        "destination": {          "ref": "string",          "write": "WRITE_MODE_UNSPECIFIED",          "namespace": "string",          "naming": "NAMING_UNSPECIFIED",          "deletes": "DELETE_MODE_UNSPECIFIED",          "typeChanges": "TYPE_CHANGES_UNSPECIFIED",          "tables": {            "property1": "string",            "property2": "string"          }        },        "schemaPolicy": "SCHEMA_POLICY_UNSPECIFIED",        "delivery": {          "require": "DELIVERY_LEVEL_UNSPECIFIED",          "commit": {            "interval": "string",            "maxBytes": "string",            "scope": "COMMIT_SCOPE_UNSPECIFIED"          },          "resumePointTimeout": "string"        },        "types": {          "infinity": "INFINITY_UNSPECIFIED"        },        "postSync": [          {            "dbt": {              "project": "string",              "command": "DBT_COMMAND_UNSPECIFIED",              "select": "string",              "exclude": "string",              "schema": "string"            },            "spark": {              "cluster": "string",              "code": {                "jar": "string",                "python": "string",                "sha256": "string",                "mainClass": "string"              },              "args": [                "string"              ],              "conf": {                "property1": "string",                "property2": "string"              }            }          }        ],        "heal": {          "mode": "HEAL_MODE_UNSPECIFIED"        },        "transform": {          "spark": {            "cluster": "string",            "code": {              "jar": "string",              "python": "string",              "sha256": "string",              "mainClass": "string"            },            "conf": {              "property1": "string",              "property2": "string"            },            "outputs": [              {                "name": "string",                "primaryKey": [                  "string"                ],                "write": "WRITE_MODE_UNSPECIFIED",                "require": "DELIVERY_LEVEL_UNSPECIFIED"              }            ]          },          "flink": {            "cluster": "string",            "code": {              "jar": "string",              "sha256": "string",              "mainClass": "string"            },            "parallelism": 0,            "conf": {              "property1": "string",              "property2": "string"            },            "outputs": [              {                "name": "string",                "primaryKey": [                  "string"                ],                "write": "WRITE_MODE_UNSPECIFIED",                "require": "DELIVERY_LEVEL_UNSPECIFIED"              }            ]          }        },        "sparkAccess": {          "emrRole": "string",          "keys": {}        },        "flinkAccess": {          "emrRole": "string",          "keys": {}        },        "resources": {          "size": {            "preset": "string",            "cpuMillis": "string",            "memoryBytes": "string"          },          "min": {            "preset": "string",            "cpuMillis": "string",            "memoryBytes": "string"          },          "max": {            "preset": "string",            "cpuMillis": "string",            "memoryBytes": "string"          },          "finishWithin": "string",          "pool": "string"        }      },      "version": "string",      "etag": "string",      "createTime": "2019-08-24T14:15:22Z",      "updateTime": "2019-08-24T14:15:22Z",      "paused": true,      "status": {        "lastSync": {          "name": "string",          "version": "string",          "state": "SYNC_STATE_UNSPECIFIED",          "error": "string",          "startTime": "2019-08-24T14:15:22Z",          "endTime": "2019-08-24T14:15:22Z",          "dataPlane": "string",          "streams": [            {              "name": "string",              "rows": "string",              "quarantinedRows": "string",              "collapsedRows": "string",              "heldCells": "string",              "heldColumns": [                "string"              ]            }          ],          "continuous": true,          "lastCommitTime": "2019-08-24T14:15:22Z",          "progress": [            {              "stream": "string",              "lagBytes": "string",              "lagRecords": "string",              "lag": "string",              "retentionLeftBytes": "string",              "retentionLeft": "string",              "time": "2019-08-24T14:15:22Z"            }          ],          "failedAttempts": 0,          "lastAttemptError": "string",          "lastAttemptTime": "2019-08-24T14:15:22Z",          "attempts": [            {              "attempt": 0,              "size": {                "preset": "string",                "cpuMillis": "string",                "memoryBytes": "string"              },              "sizeReason": "JOB_SIZE_REASON_UNSPECIFIED",              "usage": {                "cpuSeconds": 0.1,                "peakMemoryBytes": "string",                "runnerCpuSeconds": 0.1,                "runnerMemoryBytes": "string",                "seconds": 0.1              },              "rows": "string",              "bytes": "string",              "code": "string",              "lanes": {                "lanes": 0,                "limit": 0,                "busySeconds": 0.1,                "backpressuredSeconds": 0.1,                "idleSeconds": 0.1,                "rows": "string"              }            }          ]        },        "lastSuccessTime": "2019-08-24T14:15:22Z",        "openIncidents": 0,        "scaling": {          "size": {            "preset": "string",            "cpuMillis": "string",            "memoryBytes": "string"          },          "lanes": 0,          "rescaleTime": "2019-08-24T14:15:22Z",          "note": "string"        }      },      "pausedStreams": [        {          "stream": "string",          "reason": "string",          "incident": "string",          "createTime": "2019-08-24T14:15:22Z"        }      ],      "overrides": [        {          "field": "string",          "value": "string",          "specValue": "string",          "reason": "string",          "incident": "string",          "updateTime": "2019-08-24T14:15:22Z"        }      ]    }  ],  "nextPageToken": "string"}