Sets the desired deployment state of a pipeline.

The desired state is set based on the action path parameter:

• /start sets desired state to Running
• /pause sets desired state to Paused
• /shutdown sets desired state to Shutdown

The endpoint returns immediately after setting the desired state. The relevant procedure to get to the desired state is performed asynchronously, and, as such, progress should be monitored by polling the pipeline using the GET endpoints.

Note the following:

• A shutdown pipeline can be started through calling either /start or /pause
• Both starting as running and resuming a pipeline is done by calling /start
• Both starting as paused and pausing a pipeline is done by calling /pause

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.