Create a pipeline

Creates a new pipeline with no actions, owned by the caller. The new pipeline is stamped with X-Ecosystem-Id and cannot be created without one (400 ILLEGAL_ARGUMENT when absent).

Last updated:

Creates a new pipeline with no actions, owned by the caller. The new pipeline is stamped with X-Ecosystem-Id and cannot be created without one (400 ILLEGAL_ARGUMENT when absent).

POST /api/v1/pipelines

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.
X-Ecosystem-Idheaderyesstring (uuid)The ecosystem (within the workspace named by X-Workspace-Id) the call acts in. Must belong to that workspace; an ecosystem of another workspace, or one that does not exist, is refused with no further detail.

Request body

FieldTypeRequiredDescription
namestringyes
descriptionstringno
schedulestringnoA cron schedule expression.

Example request:

{
  "name": "Nightly customer sync",
  "description": "Copies customer records from Production to Staging every night.",
  "schedule": "0 2 * * *"
}

Responses

201

The created 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.

Example response:

{
  "id": "3a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
  "name": "Nightly customer sync",
  "description": "Copies customer records from Production to Staging every night.",
  "status": "DRAFT",
  "schedule": "0 2 * * *",
  "createdBy": "alex.morgan@example.com",
  "createdAt": "2026-10-12T09:00:00Z",
  "updatedAt": "2026-10-12T09:00:00Z",
  "actions": []
}

400

The request is invalid.

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