Jenkins Integration for API Testing
The Shift-Left API Jenkins plugin is a first-party build step for Freestyle jobs. It tests the connection, triggers a test pack, applies a pass-rate and fail-on-error quality gate, and writes JUnit XML and a JSON summary to the workspace. Download the HPI from the GitHub releases and upload it to Jenkins yourself, because the plugin is not in the Jenkins Update Center. It works with cloud or self-hosted Shift-Left servers.
Get the Jenkins HPI
The full plugin source is public. Take the .hpi from a tagged release, or build it yourself with mvn -B -ntp verify — then upload it to your Jenkins controller. This is a manual install: the plugin is not in the Jenkins Update Center, so Manage Jenkins will not find it by name.
Overview
The Shift-Left API Automation Integration plugin for Jenkins runs test packs from Freestyle jobs. It connects to your backend via the public API — login, trigger, poll, apply a quality gate, and optionally write JSON or JUnit XML to the workspace.
Prerequisites
- Network path from the Jenkins controller to your Shift-Left API base URL (HTTPS recommended).
- A Jenkins credential of type Username with password (email + API password).
- Shift-Left API deployment exposing the /api/v1 endpoints.
Installation
- 1
Get the .hpi — download it from a tagged release, or build it from the plugin source with mvn -B -ntp verify (it lands in target/).
- 2
In Jenkins, go to Manage Jenkins → Plugins.
- 3
Open the Advanced settings tab.
- 4
Under Deploy Plugin, click Choose File, select the .hpi, then Deploy.
- 5
Restart Jenkins when prompted to complete the installation.
- 6
Confirm under Installed plugins that Shift-Left API Automation Integration is listed.
Freestyle job configuration
Add Shift-Left API Automation Integration: Run Test Pack as a build step and configure these sections.
Shift-Left API connection
Test Pack
Execution
Quality Gate
Artifacts (optional)
Tip: After a build, open the build page and use the Shift-Left API Automation Integration link in the sidebar for a summary and links to workspace artifacts.
Step-by-step setup, every input and troubleshooting: Run test packs from Jenkins (help centre). For the tool-neutral how-to on running API tests in Jenkins, read Jenkins API testing plugin setup guide; to run security or load tests from the same packs, see API security testing and API load testing (paid add-ons).
A ready-made Jenkins file from a test pack
On a test run pack, Run in your pipeline writes a ready-made Jenkins file for you. It has no field for a password or token, so nothing you type is pasted into the file unchecked. Studio generates the same kind of file for GitHub Actions, GitLab CI, Azure Pipelines.
- +Where the runner comes from. Keep the runner in your repository, or give an https address and your own SHA-256 checksum. If the checksum does not match or the download fails, the build stops before the runner starts. The runner needs Node 18 or newer and has no npm dependency.
- +Options the file can carry.
--verdict: Fail the build on the release verdict. A verdict of "no evidence yet" fails the build by default, and a partial verdict fails unless you allow it.--tickets: Run only the tests behind the tickets you name; a ticket with no tests fails the build unless you allow that.--sarif, --fail-on-severity, --policy: Options for security runs: SARIF output, a severity gate and a committed policy file. These need the API security testing add-on. - +Pull request comments. Jenkins posts no pull request comment. GitHub, GitLab and Azure DevOps do.
- +Plans. Professional, Trial and Enterprise. The Citizen Developer edition cannot generate pipeline files.
See the release verdict for what --verdict judges.
Jenkins FAQs
Can I install the plugin from inside Jenkins?
Not by name. The plugin is a downloadable HPI file attached to the GitHub releases and is not in the Jenkins Update Center, so you upload it under Manage Jenkins, Plugins, Advanced. Release 1.0.1 is the current one.
Can Studio generate a Jenkins pipeline file?
Yes. On a test run pack, Run in your pipeline writes a ready-made Jenkins file, with an optional release-verdict gate. It is available on Professional, Trial and Enterprise. Jenkins posts no pull request comment with the verdict; GitHub, GitLab and Azure DevOps do.
Does the plugin support Pipeline (Jenkinsfile) jobs?
The current version provides a Freestyle build step. Pipeline support via a Jenkinsfile step is planned for a future release. In the meantime you can wrap the Freestyle build step in a Pipeline script block.
What Jenkins version is required?
Jenkins 2.479.x LTS or newer with Java 17 on the controller. This is the current LTS baseline.
What if Jenkins reports missing dependencies?
Install the suggested plugins (typically Credentials and related credential bindings) from the Plugins page, then restart Jenkins.
How do I verify the connection before running tests?
In the build step configuration, enter your Server URL and Credentials, then click Test Connection. The plugin will attempt to log in and confirm reachability.
Ready to add API testing to Jenkins?
Start your free 15-day trial. Install the plugin and run your first test pack today.