Pause Pipeline

Required role: write or higher.

Requests the pipeline to pause, which it will do asynchronously.

Progress should be monitored by polling the pipeline GET endpoints.

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 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 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 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.