v14

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-016793230.7 KB
v2
pipelines

Patch Pipeline

Updates a pipeline partially (only updates specified fields), with retries on 409 conflicts received from the K8s API server.

patch/api/v2/pipelines/{name}

Path parameters

namestring required

Pipeline name

Pipeline name

Query parameters

dry_runboolean nullable

Only validate the provided configuration without making changes

Only validate the provided configuration without making changes

validate_tablesboolean

Validate against source and target databases via collector API

Validate against source and target databases via collector API

validate_cdcboolean

Validate CDC configuration via collector API

Validate CDC configuration via collector API

Request body

activeboolean nullable
configobject nullable

Response

Successful Response

namestring required
activeboolean required
configobject required
status'started' | 'stopped' | 'error' | 'creating' | 'updating' | 'deleting' | 'starting' | 'stopping' | 'resetting' | 'pending' | 'unknown'

Pipeline status.

status_changed_atstring date-time nullable
currentboolean