TriggerPipelineByIdRequest
Starts a run of a saved pipeline definition.
Shape
- every_stepbooleanoptionalRun every step, whatever its path filter says. By default a step that deploys runs only if something it watches changed since its environment's last deploy, and any other filtered step runs when a step after it does.
- pipeline_timeout_secondsinteger · int32 or nulloptional0–∞The run's overall time limit, in seconds. Absent or
0uses the platform default. - sinceCommitHash (string) or nulloptionalCompare from this commit: a step that does not deploy runs only if something it watches changed between this commit and the one being built. Absent, such a step runs when a step after it does.
triggerTriggerInputoptional
- The TriggerInput schema
- branchstring or nulloptional
- commit_shastring or nulloptional
- extraobjectoptional
- kindTriggerKindpushmerge_requesttagschedulemanualoptionalWhat kind of event started the run. Defaults to
manual. - mr_idMergeRequestId (integer · int64) or nulloptional
- paramsobjectoptionalValues for the parameters the pipeline's manual trigger declares, by name. They are checked against the declared parameters before the run starts, and only these can be read from a step's config — unlike
extra, which is passed along as given.
Example
Synthesized example{
"every_step": false,
"pipeline_timeout_seconds": 79,
"since": "f68b07de0227cef7ed102ac167a383c44b3fbab3",
"trigger": {
"branch": "feat/run-header-stream",
"commit_sha": "40d6433677f79a668de495f39aeef5ac8620551b",
"extra": {},
"kind": "push",
"mr_id": 42,
"params": {}
}
}
Graph
Used inside
No schema contains this one.
Contains
Used by
Sent by 1 operation
Returned by 0 operations
No operation returns it directly.