Skip to main content
PUT
Set pipeline status
Requires a ServiceKey. See Service Keys.
PUT only changes the pipeline’s status between running and paused. To edit any other field - name, transforms, destination config - use PATCH.

Authorizations

Authorization
string
header
required

Pipeline REST endpoints require a ServiceKey. Regular GoldRush API keys are rejected with 403. See Service Keys.

Path Parameters

pipeline_id
string
required

The pipeline identifier, prefixed with pipe_.

Body

application/json

Body for PUT /platform/pipeline-api/{pipeline_id}/. Only status is accepted; all other fields are ignored.

status
enum<string>
required

Target status. Set to paused to pause a running pipeline, or running to resume a paused one.

Available options:
running,
paused

Response

Updated pipeline.

data
object

A configured pipeline. Sensitive fields inside destination_config (such as passwords) are masked as ****** on read.

error
boolean
error_message
string | null
error_code
string | null