How to use LEAPWORK’s API to export and import flows and maintain a backup?

Description

LEAPWORK allows us to easily test the endpoints in the API and explore the results.

To maintain the backup of the flows, we can do that in two ways:

1. Export/Import flow
2. Backup of the SQLite files 

To export or import the flow in LEAPWORK, there are two ways :

• Manual selection of the flows in Studio and import or export them.

• Via LEAPWORK public API endpoint 

 Export Flow: We can use the "Get Export" endpoint by using LEAPWORK API to export the automation flow. This endpoint returns a zip file containing all assets ('Folder', 'Flow', 'DataFile', 'SubFlow', etc.) on the basis of an itemId. The itemId is a unique Id of an element in the asset menu. If an itemId is not supplied   the endpoint will export all assets in the asset menu available in the controller.

 The API can be accessed on the LEAPWORK Controller at the following base URL:

 "http://localhost:9001/help/index#/"

 Example:

http://myLeapworkController.dom:9001//help/index#/

  timeoutMinutes: Define maximum timeout based on volume of export objects

  targetItemId : Unique identifier (itemId) for an Item in the Asset menu.

  Access key : To get the Access key open LEAPWORK, go to Settings > Navigate to API Acces Keys option.Copy the Access key and paste it in the mentioned image

Response body returns a URL that can be used to download a zip file containing exported assets

Sample File Name: Download All_Assets.zip

Import flow:'Import' endpoint is used to import already exported zip file to the Controller. This endpoint can be used to move flows from one controller another. Note that, target item with 'targetItemId' must be a folder.

 timeoutMinutes : Maximum timeout for upload

 targetItemId : Unique identifier for Item in the Asset hierarchy

 zip file : File to be imported

Response Body

Below is the sample response object 

{   "$id": "1",
   "IsSuccessful": true  
}

For any clarification, please contact our Priority Support.