Jenkins JobBuild
CertifiedTrigger a Jenkins job build
Jenkins JobBuild
Trigger a Jenkins job build
Calls Jenkins buildWithParameters to enqueue a build, URL-encoding foldered job names and form parameters; optionally waits for completion and verifies the build result.
type: io.kestra.plugin.jenkins.JobBuildExamples
Trigger a Jenkins job with parameters
id: jenkins_job_trigger
namespace: company.team
tasks:
- id: build
type: io.kestra.plugin.jenkins.JobBuild
jobName: deploy-app
serverUrl: http://localhost:8080
username: admin
apiToken: "{{ secret('JENKINS_API_TOKEN') }}"
parameters:
branch: main
environment:
- staging
Trigger a Jenkins job and wait for the result
id: jenkins_build_and_wait
namespace: company.team
tasks:
- id: build
type: io.kestra.plugin.jenkins.JobBuild
serverUrl: https://jenkins.example.com
username: "{{ secret('JENKINS_USER') }}"
apiToken: "{{ secret('JENKINS_API_TOKEN') }}"
jobName: folder/my-job
parameters:
DEPLOY_ENV: staging
wait: true
waitTimeout: PT30M
Properties
jobName *string
Jenkins job path
Job name or foldered path using / (e.g., team/project/job); each segment is URL-encoded.
serverUrl *string
Set Jenkins base URL
Base HTTP(S) endpoint for the Jenkins instance; trailing slash optional and defaults are rendered from Flow variables (e.g., http://jenkins.example.com: 8080).
allowedStatuses array
["SUCCESS"]SUCCESSUNSTABLEFAILURENOT_BUILTABORTEDAllowed success statuses
List of acceptable build results when wait is true: SUCCESS, UNSTABLE, FAILURE, NOT_BUILT, or ABORTED. Defaults to ['SUCCESS'].
apiToken string
API token
Jenkins API token or password paired with the username for Basic Auth.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150cancelOnTimeout booleanstring
falseCancel build on timeout
If true, attempts to cancel the queued item or stop the running build if the timeout is reached.
options
HTTP client options
Optional overrides for HTTP timeouts, proxies, or headers; merged with Basic Auth credentials.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
Retry strategy for HTTP requests.
retry is disabled by default.
Constant retry
Retry with a fixed delay between attempts.
durationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseExponential retry
Retry with exponentially increasing delays between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseRandom retry
Retry with a random delay within a configurable range between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalse[502,503,504]HTTP status codes that should be retried.
Used for idempotent methods (GET, HEAD) without their own entry in retryOnStatusCodesByMethod. Non-idempotent methods are never retried on a status code unless listed in retryOnStatusCodesByMethod. Defaults to 502, 503 and 504 for idempotent methods (GET, HEAD) only.
Per-HTTP-method overrides for which status codes should be retried.
Keys are HTTP methods (e.g. GET, POST). A method with no entry here falls back to retryOnStatusCodes. This lets a caller retry more broadly for safe, read-only methods (for example, every 5xx and a 429 for GET/HEAD) while keeping a narrower list for methods that write, where retrying a request that may have already been processed by the origin risks duplicating the effect. Example: {GET: [429, 500, 502, 503, 504], HEAD: [429, 500, 502, 503, 504]}.
["GET","HEAD"]HTTP methods for which any transport-level failure may be retried.
A transport-level failure is a connection or timeout error rather than an HTTP response (e.g. a read timeout or a connection reset mid-request). For a method listed here, any such failure is retried. Defaults to GET and HEAD HTTP methods.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
parameters object
Build parameters
Optional map sent as form data to Jenkins; values are rendered then URL-encoded.
pollInterval string
PT2SPolling interval
Frequency at which to poll the queue item and build endpoint when wait is true. Defaults to PT2S.
username string
Jenkins username
Optional username used for Basic Auth when the server is secured.
wait booleanstring
falseWait for completion
Whether to poll until the queued build finishes running.
waitTimeout string
PT10MWait timeout
Maximum duration to wait for the build to finish before timing out. Defaults to PT10M.
Outputs
buildNumber integer
Build number assigned to the queued build
buildUrl string
Direct URL to the build in Jenkins
info object
Full build details payload from Jenkins API
Only populated when wait is true.
queueId integer
Jenkins queue item ID
Parsed from the Location header returned when queuing the build.
result string
Build result
Final result status of the build (e.g., SUCCESS, FAILURE, UNSTABLE). Only populated when wait is true.
status integer
HTTP status code returned by Jenkins
