Start API Portal

In this topic, learn about:
In this topic, learn about:
Prerequisites for Starting API Portal
After installation but before starting API Portal, ensure that you have done the following:
Start Portal Script
Installer Script Has Been Updated to Pull from Docker Hub
[Issued on December 7, 2020] The API Developer Portal will no longer support Bintray and will instead rely on Docker Hub as its preferred distribution platform by the end of December 2020. As a result of this change, customers who install, reinstall or upgrade to any of the Layer7 API Developer 4.x versions with the installer script ( will need to replace it with an updated one that ensures that images are being pulled from Docker Hub.
For API Developer Portal 4.5.x installations, visit the Layer7 (CA) API Developer Portal Solutions & Patches page to download the updated installer shell script (
to start the API Portal application:
sudo ./
script performs the following tasks:
  • Checks if Docker is installed.
    If Docker is not installed, you will be prompted to install it.
    If Docker is installed, the script checks if the minimum version requirement is met. If the minimum version requirement is not met, you will be prompted to upgrade.
  • Initializes a Docker Swarm cluster and marks it as a Docker Swarm Master node.
  • Downloads the necessary images from CA Docker Registry when performing the online installation. Otherwise, a package containing the run-time images is extracted and imported into Docker.
  • Creates a
    namespace inside the Docker Swarm and deploys into it.
  • Generates a starter set of private keys and certificates.
    These key pairs are self-signed and must not be used in production. See Create and Sign Certificates for Production for more information about creating and signing certificates for production.
View Status
It may take some time to start API Portal for the first time, particularly if you are performing the online installation. For the online installation, Docker images are downloaded from the Docker registry before the services can be started.
To display a summarized view of the startup status, execute the following command:
sudo ./
If you encounter any errors when executing
, see Troubleshoot the Installation.