Skip to main content

Start the pipeline asynchronously by updating the desired state.

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

Note the following:

  • A stopped pipeline can be started through calling either /start or /pause
  • Both starting as running and resuming a pipeline is done by calling /start
  • A pipeline which is in the process of suspending or stopping cannot be started
Path Parameters
pipeline_name string REQUIRED

Unique pipeline name

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.