The LEAPWORK REST API

The LEAPWORK Automation Platform is built on a public REST API that you can easily explore and integrate with other systems such as software build systems, bug-tracking tools, and much more.

The API is hosted on the Controller, by default on port 9000. The easiest way to get started is to use the browser-based REST API explorer, which is located on http://{controller}:9000/help/index:
api previewFrom 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 Projects, use the “Projects” endpoint:
Projects endpoint in the LEAPWORK APIThe REST API can be used to control all data and methods that is available to LEAPWORK Studio including triggering automation runs and polling for results.

Please note, the API doesn’t ship with any built-in security and access to the API needs to be controlled on an organizational infrastructure level.

The in-line documentation for the API is currently a work in progress.

 

Updated February 8th 2018.