Sign in
Pipeline Lifecycle

Start Pipeline

Required role: write or higher.

Start the pipeline asynchronously by updating the desired status.

The endpoint returns immediately after setting the desired status. The procedure to get to the desired status is performed asynchronously. Progress should be monitored by polling the pipeline GET endpoints.

Note the following:

  • A stopped pipeline can be started through calling /start?initial=running, /start?initial=paused, or /start?initial=standby.
  • If the pipeline is already (being) started (provisioned), it will still return success
  • It is not possible to call /start when the pipeline has already had /stop called and is in the process of suspending or stopping.
post/v0/pipelines/{pipeline_name}/start

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

pipeline_namestring required

Unique pipeline name

Query parameters

initialstring

The initial parameter determines whether to after provisioning the pipeline make it become standby, paused or running (only valid values).

bootstrap_policy'allow' | 'reject' | 'await_approval'

Bootstrap policy.

silent_bootstrapboolean

Bootstrap the pipeline with output connectors disabled.

concurrent_bootstrapboolean

Bootstrap new and modified views concurrently, keeping the pre-existing views live while the new ones backfill in the background.

dismiss_errorboolean

Response

Action is accepted and is being performed

Changes

No recorded changes to this operation across all 51 revisions of this API.