Upgrade API Portal

Upgrade your existing API Portal to version 7.7.

6 minute read

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 2020, 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.x February 22 (7.7 20220228) Including all service packs 7.7 x to 7.7 20220228
7.7 20220228 Latest 7.7 20220228 to Latest

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.
  • Perform a back up of your API Portal software installation by taking a snapshot of your environment. Ensure that you have a file system backup and database export.

API Portal with applied patches

If you are using API Portal with applied patches, you must change the ownership of the installation path before applying an update:

sudo chown -R apache:apache {ApiPortalInstallPath}

{apiportalInstallPath} is the API Portal installation directory. API Portal is installed at /opt/axway/apiportal/htdoc by default.

Upgrade 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 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! upgrade package (for example, joomla-update-package-4.2.5.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 System > Update > Joomla, and click the Upload and Update button.

  6. Select the Joomla! upgrade package (for example, joomla-update-package-4.2.5.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
    

Upgrade from versions before May 2022

API Portal May 2022 release is integrated with Joomla 4, which results in some backward incompatible changes. Attempting to upgrade directly from versions prior to May 2022 to later versions will break database integrity.

To upgrade from before May 2022 to later releases, follow these steps:

  1. If your API Portal version is lower than February 2022, you must first upgrade to February 2022 as described in the previous sections.

  2. Establish an SSH connection to your API Portal server and locate the additional PHP settings directory:

    php --ini | grep -iF "scan for additional" | rev | cut -d' ' -f1 | rev
    
  3. Create an apiportal.ini file inside the additional PHP settings directory with the following content:

    post_max_size = 60m
    upload_max_filesize = 60m
    
  4. Restart the Apache server to reload the configuration. Depending on the installation type, the Apache service on your machine might have a name different from httpd.

    sudo systemctl restart httpd
    
  5. Open API Portal in a browser, log in to the Joomla! Administrator Interface (JAI), click System > Global Configuration > Server and ensure that you are using MySQLi database driver for Database Type field.

    If you are using a different adapter and you need to switch to MySQLi adapter, ensure that you changed the database credentials accordingly. You might need to create a MySQL user account without TLS authentication.

  6. Click Extensions > Plugins, then search and disable the T3 Framework plugin.

  7. Click Components > Joomla! Update > Upload & Update, then apply Joomla 4 by uploading the relevant file from the upgrade package.

  8. Wait for the upgrade process to finish.

  9. (Mandatory step only for when upgrading to API Portal November 2022 and later) Click System > Plugins, then search and disable the Action Log - API Portal plugin.

  10. Establish an SSH connection to your API Portal server and upgrade your product:

    sudo ./apiportal_upgrade.sh
    
  11. (Optional) To change the Database Type field back to the value which was there before, in JAI, click System > Global Configuration > Server > Database section and change your database settings. Note that Joomla 4 uses a native MySQLi driver in conjunction with One-way or Two-way authentication for the Connection Encryption field for SSL connection.

Upgrade with mandatory prerequisites

Watch the following video to learn more about upgrading API Portal from February 2022 to May 2022 update with mandatory prerequisites:

Upgrade with optional prerequisites

Watch the following video to learn more about upgrading API Portal from February 2022 to May 2022 update with optional prerequisites:

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 > Dashboard, and follow the instructions in the EasyBlog installer.
  3. Click Components > EasyDiscuss > Dashboard, and repeat the component installation as described for EasyBlog.
  4. If a newer version is available for EasyBlog or EasyDiscuss, click Update Now to update the component.

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.

Update API Portal with a service pack or patch

Service packs and patches provide important security updates, fixes for known issues, and improved performance for API Portal and its components.

To apply a service pack or patch on a software installation:

  1. Download the service pack and the associated Readme file from Axway Support.
  2. Review the Readme file for any specific instructions before you apply the service pack.