Upgrade API Portal

Upgrade your existing API Portal to 7.7.

5 minute read

This section does not describe how to upgrade API Gateway. For information on upgrading API Gateway, see API Gateway Upgrade Guide.

You can use the cumulative upgrade script to upgrade your 7.5.5 or 7.6.2 API Portal installation (including all service packs) directly to 7.7 November, or you can upgrade versions incrementally:

From To Download Package
7.5.5 7.6.2 7.5.5 to 7.6.2 Upgrade
7.6.2 7.7 GA 7.6.2 to 7.7 Upgrade
7.7 GA 7.7.x (Including all Service Packs) 7.7 GA to 7.7 Latest Update

Prerequisites

Before you upgrade your API Portal, complete the following prerequisites. These prerequisites apply for both software installation and Docker containers installation.

  • If you intend to use the EasyBlog and EasyDiscuss plugins, you must install them before you start the upgrade. For more details, see Install API Portal.
  • Stop and back up the existing API Portal files and database. There is no option to roll back after you start the upgrade.
  • To back up an API Portal software installation, perform a file system backup and export the database.

Upgrade API Portal using the cumulative upgrade script

If you have a 7.5.5 or 7.6.2 API Portal installation, you can upgrade directly to API Portal 7.7 November 2020 by using the cumulative script.

  1. Download API Portal cumulative upgrade package.

  2. Change to the directory where you saved the upgrade package, and extract it:

    tar xpzvf <package_name>.tgz
    
  3. Give executable permissions to the script apiportal_cumulative_upgrade.sh:

    chmod +x apiportal_cumulative_upgrade.sh
    
  4. Execute the script:

    sh apiportal_cumulative_upgrade
    

Upgrade API Portal from the Joomla! Administrator Interface

If you have a 7.7.x API Portal installation, you can upgrade to the latest version without having to repeat the initial installation setup.

  1. Download the API Portal upgrade package from the Axway Support.

  2. Change to the directory where you saved the upgrade package, and extract it:

    tar xpvzf <package_name>.tgz
    
  3. Extract the Joomla! update package (for example, joomla-update-package-3.9.14-package.zip) from the API Portal upgrade package to your local file system.

  4. Log in to the Joomla! Administrator Interface (JAI) (https://<API Portal host>/administrator).

  5. Click Components > Joomla! Update, and click the Upload & Update tab. If Joomla! Update is not visible in the menu, connect to your user database and execute the following query for API Portal database:

    update s8f7h_menu set menutype='main' where title like 'com_joomlaupdate'
    
  6. Select the Joomla! update package (for example, joomla-update-package-3.9.14-package.zip) from your file system.

  7. Click Upload & Install, and follow the displayed instructions.

  8. Enter the following to run the upgrade script:

    sudo ./apiportal_upgrade.sh
    

Post-upgrade steps

After the upgrade, perform the following tasks.

Reinstall Joomla! components

After upgrade, you must reinstall Easyblog and EasyDiscuss in JAI to update the component version and fix compatibility issues. The API Portal data related to the components (posts, attachments) is not affected.

  1. Log in to the JAI.
  2. Click Components > EasyBlog, and follow the instructions in the EasyBlog installer.
  3. If prompted to select the installation method, select Installation via Directory, select the available package from the drop-down list, and follow the instructions in the installer to the finish. Do not install any of the modules and plugins unless you plan to use them. To prevent installing any modules, click Modules and deselect Select All, then repeat the same for Plugins.
  4. Click Components > EasyDiscuss, and repeat the component installation as described for EasyBlog.
  5. If a newer version is available for EasyBlog or EasyDiscuss, click Update Now to update the component.

If you customized the company name in your API Portal footer using a Joomla! language override (Extensions > Languages > Overrides in JAI), you must perform the following steps to restore language overrides after upgrade:

  1. Locate the backup file /opt/axway/apiportal/htdoc/Backups/<timestamp>/language/overrides/en-GB.override.ini that is created during an upgrade. The timestamp corresponds to the time of the upgrade, for example, 20180613105149.
  2. Copy the backup file to the path /opt/axway/apiportal/htdoc/language/overrides/en-GB.override.ini.

Any customizations performed using language overrides are now restored.

Hide blog from the API Portal landing page (optional)

After the upgrade, the blog is visible and accessible on the main menu on the API Portal landing page, because the EasyBlog plugin overrides permissions. If you want to hide your blog on the landing page, do the following:

  1. Log in to JAI.
  2. Click Menus > Main Menu, and select Blog.
  3. On the Details tab, set Access to Registered, and click Save.
  4. Refresh the API Portal landing page. Blog is no longer visible in the main menu before signing in.

Consolidate vhosts and .htaccess files (optional)

During upgrade, the original vhost file is backed up to the following location: /etc/httpd/conf.d/apiportal.conf.old.

A new vhost file is deployed at the same location. If you had any customization, which you want to preserve, you must merge the old and new files together manually.

Similarly, the original .htaccess file is backed up to ${apiportal-install-dir}/.htaccess.old. However, the two files are merged automatically.

Encrypt database password

If you did not choose to encrypt your database password during the installation process, you can use the apiportal_db_pass_encryption.sh script, available from both API Portal installation and upgrade packages, to encrypt the password at any time. For more details see Encrypt database password.