
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; uses Basic Auth when credentials are provided.
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
serverUri: http://localhost:8080
username: admin
apiToken: "{{ secret('JENKINS_API_TOKEN') }}"
parameters:
branch: main
environment:
- staging
Properties
jobName *Requiredstring
Jenkins job path
Job name or foldered path using / (e.g., team/project/job); each segment is URL-encoded.
serverUrl *Requiredstring
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)
apiToken string
API token
Jenkins API token or password paired with the username for Basic Auth
options Non-dynamic
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.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
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.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
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.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
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.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
username string
Jenkins username
Optional username used for Basic Auth when the server is secured
Outputs
status integer
HTTP status code returned by Jenkins