Software installation prerequisites

Your system must meet these prerequisites before you can install API Portal.

2 minute read

Internet connection

Installing API Portal dependencies requires an Internet connection. Offline installation is not currently supported.

Hardware requirements

The minimum hardware requirements are:

  • 2 Ghz Dual Core Intel Core or AMD Opteron or faster
  • 8 GB RAM
  • 40 GB free disk space

Software requirements

API Portal has the following requirements for software components:

Operating system

You must have Red Hat Enterprise Linux (RHEL) 7/8 or CentOS 7/8 installed.


You must have one of the following installed:

  • MySQL 5.7

    API Portal does not officially support MySQL 8 as Joomla! does not support it. However, API Portal has been tested to work with MySQL 8 using a workaround. You must apply the workaround described at Joomla! and MySQL 8 before you install API Portal.

  • MariaDB 10.4 or later


API Portal requires PHP 7.1 or later. We strongly recommend you to use only officially supported PHP versions.

In addition you must have the following PHP packages installed:

  • php-cli
  • php-common
  • php-gd
  • php-intl
  • php-json
  • php-mbstring
  • php-mysqld or php-mysqli
  • php-openssl
  • php-pdo
  • php-xml
  • php-zip

Other software

API Portal requires the following to be installed:

  • API Manager 7.7 (API Portal and API Manager releases must match.)

    The monitoring feature of API Portal, which enables your API consumers to monitor application and API usage, requires a connected API Manager with monitoring metrics enabled.

  • Apache 2.4

  • OpenSSL

Install dependencies

For more information on installing dependencies, see: