From pypi

The easiest (and best) way to install is through pip:

$ python -m pip install api4jenkins

From source

Optional you can clone the public repository to install:

$ git clone
$ cd api4jenkins
$ python -m pip install .


Install following plugins for Jenkins to enable full functionality for api4jenkins:

Release History

1.4 (2021-03-31)

  • Support to retrieve test report for build

  • Support to validate Jenkinsfile

1.3 (2021-02-28)

  • Add capability to get/save artifacts for WorkflowRun.

  • Make Jenkins and Folder is subscribed and can be iterated with depth.

  • Refactor some code.

1.2 (2021-01-31)

  • Support to enable, disable, scan, get_scan_log for WorkflowMultiBranchProject

  • Call Jenkins.get_job for getting parent of Job

  • Support process input step for WorkflowRun, see WorkflowRun.get_pending_input()

  • Support user management

1.1 (2020-12-31)

  • Rewrite documentation and add more examples

  • Jenkins.build_job() and accept key word argments instead of dict

  • Support to access attribute with None type value in json

  • Fix typo in Folder.__iter__()

1.0 (2020-11-15)

  • First release