Pipelines

Update pipeline

patch/pipelines/{id}

Path parameters

idstring required

Unique pipeline identifier (e.g. pipe_abc123).

Example:pipe_abc123

Unique pipeline identifier (e.g. pipe_abc123).

Request body

idstring

Optional pipeline identifier. If omitted, the service generates one (e.g. pipe_abc123).

desired_status'active' | 'paused' | 'deleted'

Set to "paused" to pause, "active" to resume, "deleted" to tear down.

Response

Updated pipeline

idstring required

Unique pipeline identifier (e.g. pipe_abc123).

desired_status'active' | 'paused' | 'deleted' required

User-controlled lifecycle state. Set via PATCH to pause, resume, or delete.

status'setup' | 'backfill' | 'ready' | 'paused' | 'teardown' | 'error' required

Workflow-controlled execution state. Updated by the Temporal workflow.

Changes