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
| Name | In | Required | Type | Description |
|---|---|---|---|---|
X-Workspace-Id | header | yes | string (uuid) | The workspace the call acts in. Take it from the workspace list. |
X-Ecosystem-Id | header | yes | string (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
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
description | string | no | |
schedule | string | no | A 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.
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | |
name | string | yes | |
description | string | yes | |
status | one of DRAFT, VALID, INVALID | yes | |
statusReason | string | no | |
schedule | string | yes | |
createdBy | string | yes | |
createdAt | string (date-time) | yes | |
updatedAt | string (date-time) | yes | |
actions | list of object | yes | |
actions[].id | string (uuid) | yes | |
actions[].type | one of COPY, DELETE, TRANSFORM, SCRIPT, EXPORT, IMPORT | yes | |
actions[].writeStrategy | one of INSERT, MERGE, CLEAN | no | |
actions[].sequenceIndex | integer | yes | |
actions[].sourceEnvironmentId | string (uuid) | no | |
actions[].targetEnvironmentId | string (uuid) | yes | |
actions[].status | one of VALID, INCOMPLETE, INVALID | yes | |
actions[].entitySelections | list of object | yes | |
actions[].entitySelections[].selectionId | string | no | |
actions[].entitySelections[].entityIdentifier | string | no | |
actions[].entitySelections[].entityName | string | no | |
actions[].entitySelections[].entityDisplayName | string | no | |
actions[].entitySelections[].filterExpression | string | no | |
actions[].entitySelections[].transformations | list of object | no | |
actions[].entitySelections[].transformations[].fieldIdentifier | string | no | |
actions[].entitySelections[].transformations[].fieldName | string | no | |
actions[].entitySelections[].transformations[].fieldType | string | no | |
actions[].entitySelections[].transformations[].type | string | no | |
actions[].entitySelections[].transformations[].parameters | object | no | |
actions[].entitySelections[].transformations[].orderIndex | integer | no | |
actions[].entitySelections[].keyAttributes | list of string | no | |
actions[].entitySelections[].writeStrategy | one of INSERT, MERGE, CLEAN | no | |
actions[].entitySelections[].moduleIdentifier | string | no | |
actions[].entitySelections[].moduleName | string | no | |
actions[].entitySelections[].fields | list of object | no | |
actions[].entitySelections[].fields[].identifier | string | no | |
actions[].entitySelections[].fields[].name | string | no | |
actions[].entitySelections[].fields[].type | string | no | |
actions[].entitySelections[].fields[].typeDescriptor | string | no | |
actions[].config | object | yes | |
actions[].connectorName | string | no | Display 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.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |