Skip to main content
Send the complete graph, up to 2 MiB, and optionally expectedVersion. Returns the updated pipeline metadata. Invalid configuration or missing secrets returns 400; failed checks and lint findings do not block this write. An attached dataset cannot be removed. A stale version, concurrent edit, or active run returns 409; read the graph again before retrying.

Signature

Method signature on client.pipelines:

Parameters

Pass one of the argument shapes shown in the signature.
string
required
Pipeline ID with prefix pl..
PipelineGraphV1
required
Complete pipeline graph in version 1 of the public graph format.
string
The snapshot version expected to still be active. A stale version is rejected with HTTP 409.
string
The snapshot version. The SDK sends it as expectedVersion when you pass a graph snapshot.
InvalidFieldSchema[]
Snapshot diagnostics accepted when passing a complete graph snapshot. The SDK sends only graph and version (as expectedVersion); these diagnostics are not submitted.

Returns

Promise<Pipeline> A pipeline within a project.
PipelineId
required
Pipeline ID with prefix pl..
ProjectId
required
Project ID with prefix pp..
string
required
Name of the pipeline.
number
required
Pipeline version number; copying a pipeline increments the source version.
string
required
Time the pipeline was created, as an ISO 8601 timestamp.
string
required
Time the pipeline was last updated, as an ISO 8601 timestamp.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: PUT /pipelines/{pipelineId}/graph.