Skip to content

API Access Keys

Integrating components to LEAPWORK is easily done using the open REST API, which is exposed on the Controller.

In order for the specific component to gain access to LEAPWORK, an API key is required.

Note: API Access Keys settings would be available if you are logged in as an administrator.

Click “Add key”, and the access key is immediately generated by LEAPWORK:

api-access-key

Adding an API Access Key

  1. Click “Add key”, and LEAPWORK will immediately generate an access key.

  2. Use the comment field to identify which external component is using the generated key.

  3. To complete the task, click Add. This takes you back to the Access Keys Overview, where you can see the total number of keys generated by the Controller.

Managing API Access Key Scopes

When adding a new API Access Key, users can now efficiently manage permissions with a Select/Deselect all checkbox:

  • Selecting this option automatically grants all available scopes.

  • If any individual scope is deselected after selecting all, the 'Select/Deselect all' checkbox will automatically be unchecked.

  • If users manually select all individual scopes, the 'Select/Deselect all' checkbox will be checked automatically.

This enhancement simplifies API key management, ensuring better control over access permissions.

Use the comment field to identify which external component is using the generated key.

To complete the task, click Add. 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.

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