Skip to main content
Send top-level settings for one node. Nested settings are replaced as a whole. The platform validates and saves the updated graph, then returns the pipeline metadata. Use expectedVersion to detect conflicting edits.

Signature

Method signature on client.pipelines:

Parameters

string
required
Pipeline ID with prefix pl..
string
The snapshot version expected to still be active. A stale version is rejected with HTTP 409.
string
required
Identifier of the node in the pipeline graph.
object
required
Setting names and replacement values to apply to this node; include at least one setting.

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: PATCH /pipelines/{pipelineId}/graph/nodes/{nodeId}.