Skip to main content

Update pipeline

PATCH 
/platform/pipeline/:pipelineId

Partially update name, description or cron for pipelineId. Omitted properties remain unchanged. The pipeline_id and customer_id properties are read-only.

Example: manual execution only​

{
  "name": "Orders pipeline",
  "description": "Orders extraction",
  "cron": null
}

Send this body using PATCH. Set cron: null for manual execution or use a cron expression such as 0 6 * * * for a daily schedule. Changing cron updates scheduling. The source success body contains detail, for example successfully patched the item of the pipeline_id: .... The documented errors are 400 for a read-only property change and 404 for a missing pipeline.

Use Patch job input for job settings or Update JDBC sync mode for validated load-type migrations. Changing output table name or schema is not documented as supported here.

Request​

Responses​

Pipeline updated