Skip to main content

License Alteryx Products with Alteryx One Using Command Line

The AlteryxCloudLicensing.exe is stored in the bin directory of the Alteryx install version 2025.1 and later. This command performs certain licensing functions described below.

Activate License Online

Warning

Currently, Alteryx One supports online activation of Alteryx Server only.

AyxCloudLicensing.exe

Usage

Syntax/Example

Description/Parameter

Activate a Server license.

AlteryxCloudLicensing.exe activate --base-url <URL_of_Alteryx_environment> --api-key <API_KEY> --product server

Activates a Server license for a machine.

Required: Alteryx One URL, Alteryx One API key

Activate License Offline

AyxCloudLicensing.exe

Usage

Syntax/Example

Description/Parameter

Generate license request file.

AlteryxCloudLicensing.exe create-request-file [--file optional_destination_filename_with_or_without_parent_path]

The system creates a request file. The request file is used to create an activation (BIN) file.

Optional: file

Include the full path name, including drive letter and existing folder name.

Upload the request file to Alteryx One.

  1. Sign in to your Alteryx One.

  2. In the Overview tab, find the Designer Desktop or Server tile.

  3. Select the down arrow, and select Activate Offline.

  4. Drag and drop the REQ file or browse to find and select the REQ file.

  5. Select Create Activation File. The generated BIN file downloads to your computer.

Load license activation file.

AlteryxCloudLicensing.exe activate --file <required_path_to_bin_file> --product {designer,server}

The system loads the license activation (BIN) file and activates the license.

Required: file

Deactivate License

AyxCloudLicensing.exe

Usage

Syntax/Example

Description/Parameter

Deactivate license.

AlteryxCloudLicensing.exe deactivate --product {designer,server}

Deactivates license by deleting the stored JSON Web Token.

Required: product

List Available Products

AyxCloudLicensing.exe

Usage

Syntax/Example

Description/Parameter

List available products on a machine.

AlteryxCloudLicensing.exe info

Returns a list of information stored in the JSON Web Token of each product:

  • Account Name

  • Contract Expiration Date

  • Worskpace Name

In this section: