Upgrade from Old Version

Your test data, settings, etc. live under the <ATB_DATA_DIR> folder (refer to Administration for the location), and stay untouched during ATB upgrade. The one exception is the no-JRE build’s config.properties file, which sits in the folder where you extracted the zip. The Java tab below covers it.

Upgrade

macOS

Exit API Test Base app if it is running.

Download the latest API Test Base version from the release page.

Open the new dmg file, and you’ll be able to drag the new version of API Test Base.app to your /Applications folder, replacing the old one.

Windows

Exit API Test Base app if it is running.

Download the latest API Test Base version from the release page.

For the installer (setup exe), running a new version installer will automatically uninstall the old ATB version and install the new version.

For the portable, just abandon the old version and start using the new version.

Docker

Stop or remove the existing API Test Base container (to avoid port number conflict with the new container).

Run the new version following the instructions on Quick Start page, using the same host data folder in the -v parameter as before, so that the new container sees your existing data.

Java

When the build is used for API test automation in CI/CD pipeline, there is no need to upgrade, since the build is discarded after the pipeline run. You can just change the ATB version number in your pipeline definition file to use the latest ATB version.

If you use the build for other purposes like trying out ATB, the steps for upgrade are as follows.

Stop the existing API Test Base instance (to avoid port number conflict with the new instance).

Download apitestbase-0.40.5-allos-nojre.zip from the release page.

Extract the downloaded zip. If you have changed config.properties in the old version’s folder (next to config.yml), carry your changes over to the new version’s copy (see Changing Configurations).

Run the new version following the instructions on Quick Start page.