How to add API Access Keys to a Leapwork Controller

How to add API Access Keys to a Leapwork Controller

Introduction

REST API (exposed to the Controller) is used to integrate components with Leapwork. For a specific component to gain access to the Leapwork environment, an API key is required.

Please Note: You must have administrator role in Leapwork.

Add API Access Keys

  1. Open Leapwork Settings.

  2. Click API Access Keys.

  3. Click Add Key. The access key is immediately generated by Leapwork.

Add Application Name in Comment

  1. Use the comment field to identify which external component is using the generated key, for example, Jira, SNOW, DevOps etc.

  2. The relative checkbox items in the Scope field above pertain to the various APIs we can give access to.

  3. Select the Team to specify which assets are being given access to. You can select either all or any specific teams as per their requirement.

  4. Click Add. An API Access Keys window appears. The latest entry is listed on the screen. You will see all keys generated by the Controller.

  5. Right-click on the Access key value column and copy the Access key and use them to call endpoints in Leapwork from PowerShell/plugins or any external application.

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

If you have any questions, please reach out to our Priority Support team.