GuidesPipeline API ReferenceChangelog
Pipeline API Reference

Pause a running PipelineVersion.

This endpoint pauses a running PipelineVersion. For a pipeline version using template created for Streaming runtime environment, the pause operation saves a snapshot of the current state of processing. When the pipeline is resumed or upgraded, the pipeline starts from the last saved state. For a pipeline version using template create for Batch runtime environment, the pause operation pauses the future scheduled runs. If a pipeline is currently running then that run will continue until it is successful or failed. For a non scheduled batch pipeline this will return an HTTP status code of 400

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

System generated identifier for the Pipeline.

string
required

System generated identifier for the PipelineVersion.

Headers
string

Identifier for a specific http request. If not present, one will be generated.

string

Common identifier for multiple http requests to indicate they are associated in some way. If not present, one will be generated.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*