UiPath Robot

LicenseTool Command Descriptions

The UiPath.LicenseTool.exe is a command line utility which enables you to activate your machine online or offline, and update your license information. The utility can be found in the C:\Program Files (x86)\UiPath\Studio folder by default.

Please note that this tool is only used to activate your license locally. If you choose to activate your license with this tool, it is important to specify that you use an external license when you create a Robot in Orchestrator for that particular machine.

All the examples displayed on this page are constructed from the assumption that you first navigated to the location of the UiPath.LicenseTool.exe utility, by using the cd command (cd C:\Program Files (x86)\UiPath\Studio).

Online Operations

The following commands require an active internet connection in order to process your request.

Activate

The activate command is used to activate a license online via an existing license code. The following parameters are supported:

Parameter
Description
Priority

-l, --LicenseCode

The license code required for activation.

Mandatory

-u, --ProxyUrl

The URL used for the proxy connection (such as http://your.proxy.server.com).

Optional

-p, --ProxyPort

The Port number of the proxy connection.

Optional. Mandatory if the -u parameter is used.

-s, --ProxyUser

The username associated with your proxy connection.

Optional. Mandatory if the -u parameter is used.

-w, --ProxyPassword

The password for the user associated with your proxy connection.

Optional. Mandatory if the -u parameter is used.

C:\Program Files (x86)\UiPath\Studio\UiPath.LicenseTool.exe activate -l 9555-2303-2194-5598
License registration state: ActiveLicense
License successfully activated!

Online activation can also be done from Studio.

Update

The update command is used update an existing license online. The following parameters are supported:

Parameter
Description
Priority

-u, --ProxyUrl

The URL used for the proxy connection (such as http://your.proxy.server.com).

Optional

-p, --ProxyPort

The Port number of the proxy connection.

Optional. Mandatory if the -u parameter is used.

-s, --ProxyUser

The username associated with your proxy connection.

Optional. Mandatory if the -u parameter is used.

-w, --ProxyPassword

The password for the user associated with your proxy connection.

Optional. Mandatory if the -u parameter is used.

C:\Program Files (x86)\UiPath\Studio\UiPath.LicenseTool.exe update
License registration state: ActiveLicense
License successfully updated!

Deactivate

The deactivate command is used to deactivate a local license. This way, the license becomes available for activation on a different computer. The following parameters are supported:

Parameter
Description
Priority

-u, --ProxyUrl

The URL used for the proxy connection (such as http://your.proxy.server.com).

Optional

-p, --ProxyPort

The Port number of the proxy connection.

Optional. Mandatory if the -u parameter is used.

-s, --ProxyUser

The username associated with your proxy connection.

Optional. Mandatory if the -u parameter is used.

-w, --ProxyPassword

The password for the user associated with your proxy connection.

Optional. Mandatory if the -u parameter is used.

C:\Program Files (x86)\UiPath\Studio\UiPath.LicenseTool.exe deactivate
License registration state: NoLicenseAvailable
License successfully deactivated!

Offline Operations

Activation-Request

The activation-request command is used to generate an activation token from your license code. The generated token needs to be used on the Activation Portal to generate the corresponding license file. The following parameters are supported:

Parameter
Description
Priority

-l, --LicenseCode

The license code required for activation.

Mandatory

C:\Program Files (x86)\UiPath\Studio\UiPath.LicenseTool.exe activation-request -l 9555-2303-2194-5598
Activation Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LTU1OTgiLCJlbWFpbCI6InNvbWUuZW1haWxAZXhhbXBsZS5vcmciLCJtZXRhZGF0YSI6eyJyYW0iOiIzNDE0NjA0MTg1NiIsImRpc3BsYXlOYW1lIjoiSW50ZWwoUikgVUhEIEdyYXBoaWNzIDYzMCIsInZlcnNpb24iOiIxOS43LjAiLCJzeXN0ZW1MYW5nIjoiMDQwOSIsInN5c3RlbU1vZGVsIjoiT3B0aVBsZXggNTA2MCIsIm9zTmFtZSI6IlBDLURPRE9JVUIiLCJ1c2VyTmFtZSI6ImJvZ2Rhbi5kb2RvaXUiLCJzeXN0ZW1OYW1lIjoiUEMtRE9ET0lVQiIsImRpc3BsYXlSZXMiOiIxMDI0IGJ5IDc2OCBwaXhlbHMsIFRydWUgQ29sb3IsIDYwIEhlcnR6IiwicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtVHlwZSI6Ing2NC1iYXNlZCBQQyJ9LCJsaWNlbnNpbmdNb2RlbERhdGEiOnsidXNlcklkIjoiYm9nZGFuLmRvZG9pdSIsIm1hY2hpbmVJZCI6IlBDLURPRE9JVUIifX0=
Go to https://activate.uipath.com and paste the activation token in the dialogue box to generate the license file for offline activation.

Activate-Offline

The activate-offline command is used to activate a license offline. It uses the license file generated by the Activation Portal from the provided activation token generated by the activation-request command. The following parameters are supported:

Parameter
Description
Priority

-f, --LicenseFile

The path to the license file obtained from the activation portal.

Mandatory

C:\Program Files (x86)\UiPath\Studio\UiPath.LicenseTool.exe activate-offline -f c:\Downloads\license.txt
License registration state: ActiveLicense
License successfully activated!

Offline activation can also be done from Studio.

Update-Request

The update-request command is used to generate an update token for your license. The update token needs to be used on the Activation Portal to generate the corresponding license file. The following parameters are supported:

Parameter
Description
Priority

-e, --Email

The email address for which you want to activate a license.

Mandatory

C:\Program Files (x86)\UiPath\Studio\UiPath.LicenseTool.exe update-request -e some.email@example.org
Update Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LTU1OTgiLCJlbWFpbCI6bnVsbCwibWV0YWRhdGEiOnsicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtTW9kZWwiOiJPcHRpUGxleCA1MDYwIiwidXNlck5hbWUiOiJib2dkYW4uZG9kb2l1IiwiZGlzcGxheVJlcyI6IjEwMjQgYnkgNzY4IHBpeGVscywgVHJ1ZSBDb2xvciwgNjAgSGVydHoiLCJ2ZXJzaW9uIjoiMTkuNy4wIiwicmFtIjoiMzQxNDYwNDE4NTYiLCJzeXN0ZW1MYW5nIjoiMDQwOSIsIm9zTmFtZSI6IlBDLURPRE9JVUIiLCJkaXNwbGF5TmFtZSI6IkludGVsKFIpIFVIRCBHcmFwaGljcyA2MzAiLCJzeXN0ZW1UeXBlIjoieDY0LWJhc2VkIFBDIiwic3lzdGVtTmFtZSI6IlBDLURPRE9JVUIifSwibGljZW5zaW5nTW9kZWxEYXRhIjp7InVzZXJJZCI6ImJvZ2Rhbi5kb2RvaXUiLCJtYWNoaW5lSWQiOiJQQy1ET0RPSVVCIn19
Go to https://activate.uipath.com and paste the update token in the dialogue box to generate the license file for offline update.

Update-Offline

The update-offline command is used to update a license offline. It uses the generated file by the Activation Portal from the provided update token generated by the update-request command. The following parameters are supported:

Parameter
Description
Priority

-f, --LicenseFile

The path to the license file obtained from the activation portal.

Mandatory

C:\Program Files (x86)\UiPath\Studio\UiPath.LicenseTool.exe update-offline -f c:\Downloads\license-update.txt
License registration state: ActiveLicense
License successfully updated!

Deactivation-Request

The deactivation-request command is used to deactivate a local license offline and generate a deactivation token. The license is immediately deactivated on the local computer and another one can be activated if needed. Please note that the license which was deactivated online with this command can not be reused until it is released by using the generated deactivation token on this page. No parameters are required by this command.

C:\Program Files (x86)\UiPath\Studio\UiPath.LicenseTool.exe deactivation-request
Deactivation Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LTU1OTgiLCJsaWNlbnNpbmdNb2RlbERhdGEiOnsidXNlcklkIjoiYm9nZGFuLmRvZG9pdSIsIm1hY2hpbmVJZCI6IlBDLURPRE9JVUIifSwibWV0YWRhdGEiOnsib3NOYW1lIjoiUEMtRE9ET0lVQiIsInVzZXJOYW1lIjoiYm9nZGFuLmRvZG9pdSIsInZlcnNpb24iOiIxOS43LjAiLCJkaXNwbGF5UmVzIjoiMTAyNCBieSA3NjggcGl4ZWxzLCBUcnVlIENvbG9yLCA2MCBIZXJ0eiIsInN5c3RlbU5hbWUiOiJQQy1ET0RPSVVCIiwicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtVHlwZSI6Ing2NC1iYXNlZCBQQyIsInJhbSI6IjM0MTQ2MDQxODU2IiwiZGlzcGxheU5hbWUiOiJJbnRlbChSKSBVSEQgR3JhcGhpY3MgNjMwIiwic3lzdGVtTGFuZyI6IjA0MDkiLCJzeXN0ZW1Nb2RlbCI6Ik9wdGlQbGV4IDUwNjAifX0=
License successfully deactivated locally!
To release the license on the sever side and use it on another machine, go to https://activate.uipath.com/deactivate and paste the deactivation-request.

Generic Operations

The UiPath.LicenseTool.exe utility also contains a few generic commands. They provide information about your license, and can help you get accustomed to the supported commands and parameters.

Command
Description

info

Displays information about the license, such as:

  • Activation Id
  • License registration state
  • License code
  • Email
  • Start date
  • End date
  • Grace Period (days)
  • End date including grace period
  • Next check date

help

Displays information about all the supported commands and parameters.

version

Displays the version of the UiPath.LicenseTool.exe utility.

Updated 21 days ago


LicenseTool Command Descriptions


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.