How to add API Access Keys to a Leapwork Controller

Integrating components to Leapwork is easily done using the open REST API, which is exposed to the Controller. In order for the specific component to gain access to Leapwork, an API key is required.

To perform below steps user must have administrator role in Leapwork.

Go to Leapwork Settings

Click "API Access Keys"

Click “Add key”

and the access key is immediately generated by Leapwork:

Add Application Name in Comment

Use the comment field to identify which external component is using the generated key, for example, Jira, SNOW, DevOps etc. To complete the task, click Add. 

Access keys overview

This takes you back to the Access keys overview, where you at any given time will be able to see the total number of keys generated by the Controller.

Copy the Access key and use them to call endpoints in Leapwork from PowerShell/ plugins or any external application.

Please see the REST API Documentation for more detailed instructions on how to use the REST API and the API Access keys.

For any clarification, please contact our Priority Support.