Skip to main content

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.
Path Parameters
pipeline_name string REQUIRED

Unique pipeline name

Query Parameters
initial string

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

Responses
202

Action is accepted and is being performed

400

Action could not be performed

Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

404

Pipeline with that name does not exist

Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.