Change a pipeline

Changes a pipeline's name, description or schedule. Requires the change-pipeline right on every environment the pipeline references.

Last updated:

Changes a pipeline's name, description or schedule. Requires the change-pipeline right on every environment the pipeline references.

PUT /api/v1/pipelines/{pipelineId}

Authorization

Requires a signed-in person with this scope: pipelines:write.

Parameters

NameInRequiredTypeDescription
X-Workspace-Idheaderyesstring (uuid)The workspace the call acts in. Take it from the workspace list.
pipelineIdpathyesstring (uuid)The pipeline's id.

Request body

FieldTypeRequiredDescription
namestringno
descriptionstringno
schedulestringno

Example request:

{
  "name": "Nightly customer sync (EU only)"
}

Responses

200

The updated pipeline.

FieldTypeRequiredDescription
idstring (uuid)yes
namestringyes
descriptionstringyes
statusone of DRAFT, VALID, INVALIDyes
statusReasonstringno
schedulestringyes
createdBystringyes
createdAtstring (date-time)yes
updatedAtstring (date-time)yes
actionslist of objectyes
actions[].idstring (uuid)yes
actions[].typeone of COPY, DELETE, TRANSFORM, SCRIPT, EXPORT, IMPORTyes
actions[].writeStrategyone of INSERT, MERGE, CLEANno
actions[].sequenceIndexintegeryes
actions[].sourceEnvironmentIdstring (uuid)no
actions[].targetEnvironmentIdstring (uuid)yes
actions[].statusone of VALID, INCOMPLETE, INVALIDyes
actions[].entitySelectionslist of objectyes
actions[].entitySelections[].selectionIdstringno
actions[].entitySelections[].entityIdentifierstringno
actions[].entitySelections[].entityNamestringno
actions[].entitySelections[].entityDisplayNamestringno
actions[].entitySelections[].filterExpressionstringno
actions[].entitySelections[].transformationslist of objectno
actions[].entitySelections[].transformations[].fieldIdentifierstringno
actions[].entitySelections[].transformations[].fieldNamestringno
actions[].entitySelections[].transformations[].fieldTypestringno
actions[].entitySelections[].transformations[].typestringno
actions[].entitySelections[].transformations[].parametersobjectno
actions[].entitySelections[].transformations[].orderIndexintegerno
actions[].entitySelections[].keyAttributeslist of stringno
actions[].entitySelections[].writeStrategyone of INSERT, MERGE, CLEANno
actions[].entitySelections[].moduleIdentifierstringno
actions[].entitySelections[].moduleNamestringno
actions[].entitySelections[].fieldslist of objectno
actions[].entitySelections[].fields[].identifierstringno
actions[].entitySelections[].fields[].namestringno
actions[].entitySelections[].fields[].typestringno
actions[].entitySelections[].fields[].typeDescriptorstringno
actions[].configobjectyes
actions[].connectorNamestringnoDisplay name of the workspace connector an Export writes through, beside its id in config. Null when the action references no connector or that connector was deleted.

400

The request is invalid.

FieldTypeRequiredDescription
messagestringyes
statusintegeryes
errorCodestringyes
timestampstring (date-time)no
pathstringno
detailsobjectno

403

The caller lacks the change-pipeline right on a referenced environment.

FieldTypeRequiredDescription
messagestringyes
statusintegeryes
errorCodestringyes
timestampstring (date-time)no
pathstringno
detailsobjectno

404

There is no such pipeline.

FieldTypeRequiredDescription
messagestringyes
statusintegeryes
errorCodestringyes
timestampstring (date-time)no
pathstringno
detailsobjectno