Stop the pipeline asynchronously by updating the desired state.

There are two variants:

• /stop?force=false (default): the pipeline will first atomically checkpoint before deprovisioning the compute resources. When resuming, the pipeline will start from this
• /stop?force=true: the compute resources will be immediately deprovisioned. When resuming, it will pick up the latest checkpoint made by the periodic checkpointer or by a prior /checkpoint call.

The endpoint returns immediately after setting the desired state to Suspended for ?force=false or Stopped for ?force=true. In the former case, once the pipeline has successfully passes the Suspending state, the desired state will become Stopped as well. The procedure to get to the desired state is performed asynchronously. Progress should be monitored by polling the pipeline GET endpoints.

Note the following:

• The suspending that is done with /stop?force=false is not guaranteed to succeed:
• If an error is returned during the suspension, the pipeline will be forcefully stopped with that error set
• Otherwise, it will keep trying to suspend, in which case it is possible to cancel suspending by calling /stop?force=true
• /stop?force=true cannot be cancelled: the pipeline must first reach Stopped before another action can be done
• A pipeline which is in the process of suspending or stopping can only be forcefully stopped

Path Parameters
pipeline_name string — REQUIRED Unique pipeline name

Query Parameters
force boolean The force parameter determines whether to immediately deprovision the pipeline compute resources (force=true) or first attempt to atomically checkpoint before doing so (force=false, which is the default).

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.
405 Action is not supported 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.
501 Action is not implemented because it is only available in the Enterprise edition 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.
503 Action can not be performed (maybe because the pipeline is already suspended) 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.