GuidesPipeline API ReferenceChangelog
Pipeline API Reference

Update scheduler configuration for PipelineVersion.

put
https://Use API Lookup for a base URL/v2/pipelines//versions//scheduler-configuration

Updates the scheduler configuration for the PipelineVersion. This can only be applied to PipelineVersions that are in the READY state.

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

The configuration of the scheduler for running the Jobs based on the provided criteria. If scheduler configuration is not provided then the platform runs the version immediately.

string
enum

The CatalogTriggerOptions support running the pipeline version based on changes detected on the input catalogs. Either catalogTriggerOptions or timeTriggerOptions must be present.

Allowed:
timeTriggerOptions
object

The TimeTriggerOptions support running the pipeline version on a window-bounded frequency, optionally based on changes detected on the input catalogs by the version resolver. Either catalogTriggerOptions or timeTriggerOptions must be present.

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

Updated 3 months ago

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

Updated 3 months ago