Jenkins Integration

Shift-Left API for Jenkins

Add Shift-Left API test packs to Jenkins Freestyle jobs with a single build step. Quality gates, JUnit output, and a built-in test connection check — install the HPI and go.

Start TrialAll Integrations

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.

Plugin ID:shift-left-api-automation-integration
Min. Jenkins:2.479.x LTS
Java:17+

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. 1

    Download the .hpi file from the repository (e.g. totalshiftleft.shift-left-api-automation-integration-1.0.0.hpi).

  2. 2

    In Jenkins, go to Manage Jenkins → Plugins.

  3. 3

    Open the Advanced settings tab.

  4. 4

    Under Deploy Plugin, click Choose File, select the .hpi, then Deploy.

  5. 5

    Restart Jenkins when prompted to complete the installation.

  6. 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

Server URLBase URL only (e.g. https://app.totalshiftleft.ai) — no trailing slash.
Tenant IDLeave empty unless your environment requires multi-tenant routing.
CredentialsPick a Username with password credential. Click Test Connection to verify login and reachability.

Test Pack

Pack IDPick a pack from the dropdown (auto-populated after successful connection).

Execution

Wait for completionLeave enabled to poll until the run finishes or times out.
Poll interval (seconds)Seconds between status checks. Default: 10.
Overall timeout (minutes)Maximum wait time before the step times out. Default: 60.

Quality Gate

Pass threshold (%)Minimum pass rate. Use 0 to disable threshold checking.
Fail build when any ERROR testsFail on ERROR results regardless of threshold.
Build result on gate failureChoose FAILURE (blocks the build) or UNSTABLE (non-blocking warning).

Artifacts (optional)

Write JSON summaryEnable and set a workspace-relative path for the JSON report.
Write JUnit XMLEnable and set a path. Add a Publish JUnit test result report post-build step pointing at this file.

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.

Jenkins FAQs

Contact us at

support@totalshiftleft.com

to learn more

  • 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.

Start TrialBook Demo