Skip to main content

Start, pause or shutdown a pipeline.

The endpoint returns immediately after performing initial request validation (e.g., upon start checking the program is compiled) and initiating the relevant procedure (e.g., informing the runner or the already running pipeline). The state changes completely asynchronously. On error, the pipeline transitions to the Failed state. The user can monitor the current status of the pipeline by polling the GET /pipelines and GET /pipelines/{pipeline_name} endpoint.

The following values of the action argument are accepted:

  • start: Start the pipeline
  • pause: Pause the pipeline
  • shutdown: Terminate the pipeline
Path Parameters
pipeline_name string REQUIRED

Unique pipeline name

action string REQUIRED

Pipeline action (one of: start, pause, shutdown)

Responses
202

Action accepted and is being performed

400

Unable to accept action

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.