Creating and Installing an IBM API Key

The VE license server requires an API key (filename apikey.json) to be able to run on an instance in the IBM cloud. Perform the following steps to create and install this key:

Step 1: if you have not created an API key yet, create and download the API key.

You can use the same key for several license server systems. So this step may not be needed.

Go to Manage > Access (IAM) > API keys and click on Create an IBM Cloud API key as shown below:

This will open the Create API key window. In this window enter

  • Name and
  • Description

Then click on Create.

Please note: you will be offered to download the key for a short period of time after creating it. This is the only opportunity to download it. Therefore, download the key immediately.

Step 2: install the API key on the license server.

To install the key on the license server, do the following: copy the API key (name apikey.json) to the directory /opt/license-server on the license server instance in the cloud using your preferred method (e.g., SFTP).

Step 3: check if the license server starts normally.

If the key is missing, the license server log (/opt/license-server/license_log/license.log; starting with VE license server 1.1.11 the path is /opt/license-server/log/license.log) shows the error message Failed to find apikey.json file! After the key has been correctly installed, this error should be gone.



© Stromasys, 1999-2024  - All the information is provided on the best effort basis, and might be changed anytime without notice. Information provided does not mean Stromasys commitment to any features described.