Skip to main content
POST
Pause Beam Config Handler
Stops the pipeline from processing data. The config, sinks, and deployment stay in place, and Beam holds incoming data until you resume. To resume, call Deploy. If the pipeline is not deployed, the call does nothing.
Paused pipelines can lose data. While a pipeline is paused, Beam holds incoming data for up to 2 days. Data older than that is dropped and is not delivered when you resume. See Pausing and data retention.
Use Teardown instead to remove the deployment. After a teardown, data that arrives before the next deploy is not delivered.
Required permission: edit — owners and editors.
Path parameters:
Response:

Authorizations

X-API-KEY
string
header
required

Path Parameters

config_id
string
required

Response

Successful Response

message
string
required