submit_input
Submit parameters to a Jenkins pipeline input step to proceed, or abort the paused build to reject the input.
Instructions
Respond to a pipeline input step of a build that is paused for input in Jenkins
Warnings: Omitting a declared parameter settles it with null — Jenkins does not fall back to the declared defaults, so every declared parameter must be submitted. That is enforced whenever the pending input can be discovered; when the pending inputs cannot be fetched (wfapi endpoint missing or erroring) an explicit input_id is submitted as-is, so check the declared parameters yourself in that case. If this call times out the input may or may not have been settled: re-check with get_pending_inputs rather than retrying, because a settled input rejects a second submission.
Args: fullname: The fullname of the job number: The number of the paused build, use get_pending_inputs to confirm its pending input (and get_running_builds to locate a paused build that is not the job's last one) input_id: The id of the pending input, if None, resolved automatically when exactly one is pending parameters: A mapping of parameter name to value, e.g. {'APPROVE': True, 'TARGET': 'prod'} action: 'proceed' to continue the pipeline, 'abort' to reject the input and abort the build
Returns: A dict with the fullname, number, inputId and the Jenkins action that was submitted: 'proceed' with values, 'proceedEmpty' with none, or 'abort'
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | No | proceed | |
| number | Yes | ||
| fullname | Yes | ||
| input_id | No | ||
| parameters | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||