GuidesPipeline API ReferenceChangelog
Pipeline API Reference

Upgrade a PipelineVersion.

This endpoint upgrades this PipelineVersion to a different pipeline version as provided in the request. For a pipeline version using template created for Streaming runtime environment, the framework saves the snapshot of the current state of processing and uses the saved state to run the new pipeline version. For pipeline version using template created for Batch runtime environment, the current running job for the version is not stopped, however, the future scheduled runs are canceled. The new pipeline version is scheduled.

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.

Body Params

Upgrade request options containing system generated identifier (UUID) of the PipelineVersion to upgrade to.

Common options for an operation.

boolean

Defines if the pipeline is highly available using a standby master

string

RunAsId Id to run the pipeline

uuid
required

System generated identifier (UUID) for the PipelineVersion to upgrade to.

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
*/*