Method
updatePipeline PATCH
Copy PATCH

Updates a pipeline for executing multiple steps.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes pipelineId str The ID of the pipeline to update.
No projectId str A unique string identifier for the pipeline.
No pipelineVariableMappings List[PythonFunctionArgument] List of Python function arguments for the pipeline.
No cron str A cron-like string specifying the frequency of the scheduled pipeline runs.
No isProd bool Whether the pipeline is a production pipeline or not.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result Pipeline
KEY TYPE Description
pipelineName str The name of the pipeline this step is a part of.
pipelineId str The reference to the pipeline this step belongs to.
createdAt str The date and time which the pipeline was created.
notebookId str The reference to the notebook this pipeline belongs to.
cron str A cron-style string that describes when this refresh policy is to be executed in UTC
nextRunTime str The next time this pipeline will be run.
isProd bool Whether this pipeline is a production pipeline.
warning str Warning message for possible errors that might occur if the pipeline is run.
createdBy str The email of the user who created the pipeline
steps PipelineStep A list of the pipeline steps attached to the pipeline.
pipelineReferences PipelineReference A list of references from the pipeline to other objects
latestPipelineVersion PipelineVersion The latest version of the pipeline.
codeSource CodeSource information on the source code
pipelineVariableMappings PythonFunctionArgument A description of the function variables into the pipeline.

Exceptions:

TYPE WHEN
DataNotFoundError

pipelineId is not found.
DataNotFoundError

projectId is not found.
Language:

Coming Soon!

© Copyright 2025