The LEAPWORK Public REST API

Jenkins is a very popular tool to orchestrate and administer build and release pipelines. Test automation is growing into a tool like Jenkins, and the community around Leaptest has build a native Jenkins plugin, that makes it very simple to trigger test cases in Leaptest to run.

This video includes the following:

  • An overview of the integration between Jenkins and Leaptest (click on thumbnail to download overview slide).
     Leaptest Jenkins integration overview
  • Downloading the Leaptest  native Jenkins plugin from the GitHub repository (link: https://github.com/Customatics/)
  • Install the Leaptest plugin on a Jenkins server
  • Create a project and a build definition including the Leaptest plugin as a build step
  • Configure the Leaptest build step and get a brief introduction to schedules in Leaptest
  • Trigger test cases to run on cloud hosted machines from a build in Jenkins.
  • Inspect test results in Jenkins.

The LEAPWORK Automation Platform ships with a REST API allowing any third-party system access to run automation flows on the platform and to retrieve the results. The REST API makes it easy to integrate with software build systems and bug-tracking tools, and to incorporate automated flows as part of CI/CD pipelines.

The API is hosted on the Controller, by default on port 9001. The easiest way to get started is to use the browser-based REST API explorer, which is located on http://{controllerMachine}:{controllerPort}/help/index

leapwork api

From there, it’s possible to dig into each part of the API and try it out. For instance, to understand how to get a list of all Schedules, use the “Get All Schedules” endpoint:

api endpoint

The REST API can be used to control various aspects of the LEAPWORK Automation Platform, including triggering automation runs, polling for results read, and update variable values.

LEAPWORK API has basic in-line documentation of all endpoints, and all endpoints have links to detailed documentation about its parameters and usage. Read the full API documentation.

If you have any questions, please contact priority support on prioritysupport@leapwork.com