Updating an Analytics API Key
Encryption Procedures Available
The API key facilitates communication with internal ThingWorx Analytics microservice APIs and is only applicable for release 8.5.0 and later. You will need this key for any scenario that requires access to the internal ThingWorx Analytics API layer.
The API key is generated and encrypted automatically at the end of the installation process. For security, the key is not stored in plain text anywhere, so you will need to make a note of it. By default, the API key will expire in 90 days, however, you can manually change the expiration date. See
Changing the API Key Expiration Date.
If you forget or need to update the ThingWorx Analytics API key, you must generate a new key. Follow the appropriate links below to find procedures for generating and encrypting a new key.
If you are using an earlier version of ThingWorx Analytics, these procedures are not necessary.
Changing the API Key Expiration Date
You can manually change the expiration date for the ThingWorx Analytics API key.
1. In the installation directory where your ThingWorx Analytics server is installed, navigate to the config folder and open the system-environment-variables.properties file.
2. Find the #keyStore section and update the key.store.api.key.expiration property with a new date. You can use the following ISO standard date format: yyyy-mm-dd
3. Save the file and restart your ThingWorx Analytics server in order for the change to take effect.