Update Pipeline Definition

Overview

Partially update a pipeline's properties. This endpoint allows you to modify pipeline-level settings like name, description, and schedule.

Updatable Fields

Field	Type	Description
`name`	string	Pipeline display name
`description`	string	Pipeline description
`cron`	string	Cron expression for scheduling (set to `null` for manual execution)

Read-Only Fields

The following fields cannot be updated:

pipeline_id - Immutable identifier
customer_id - Set from authentication

Examples

Update Pipeline Name and Description

PATCH /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d

{
  "name": "Updated Pipeline Name",
  "description": "New description for the pipeline"
}

Response (200 OK):

{
  "detail": "successfully patched the item of the pipeline_id: 1b33ad2f_33d3_4837_9eeb_83c82c8b909d"
}

Change Pipeline Schedule

Change from daily to hourly:

PATCH /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d

{
  "cron": "0 * * * *"
}

Response (200 OK):

{
  "detail": "successfully patched the item of the pipeline_id: 1b33ad2f_33d3_4837_9eeb_83c82c8b909d"
}

Disable Scheduled Execution (Manual Only)

PATCH /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d

{
  "cron": null
}

Response (200 OK):

{
  "detail": "successfully patched the item of the pipeline_id: 1b33ad2f_33d3_4837_9eeb_83c82c8b909d"
}

Enable Daily Schedule

PATCH /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d

{
  "cron": "0 6 * * *"
}

Response (200 OK):

{
  "detail": "successfully patched the item of the pipeline_id: 1b33ad2f_33d3_4837_9eeb_83c82c8b909d"
}

Error Responses

400 Bad Request - Read-Only Property

{
  "detail": "Property pipeline_id is read only"
}

404 Not Found

{
  "detail": "pipeline_id invalid_pipeline_id not found"
}

Common Cron Expressions

Schedule	Cron Expression
Every hour	`0 * * * *`
Every 6 hours	`0 /6 * *`
Daily at 6 AM	`0 6 * * *`
Daily at midnight	`0 0 * * *`
Weekly on Sunday at midnight	`0 0 * * 0`
Monthly on the 1st at midnight	`0 0 1 * *`

Notes

When updating cron, the pipeline schedule is automatically updated
To update job-level properties (like input configuration), use the PATCH /platform/jobs/:jobId/input endpoint
To change sync mode, use the POST /platform/jobs/jdbc/:jobId/sync-mode endpoint
Changing output table name or schema is currently not supported via API