Quick start installation

This topic describes how to perform a quick start installation of API Gateway on Linux. A quick start installation is a simple, standard installation of API Gateway (for example, for a demonstration or proof of concept).

Note   Windows is supported only for a limited set of developer tools, see Install developer tools on Windows. API Gateway and API Manager do not support Windows.

The API Gateway installer provides a default Standard installation option, which installs the following API Gateway components:

  • API Gateway Server
  • QuickStart tutorial
  • API Gateway Analytics
  • Policy Studio
  • Configuration Studio
  • Package and deployment tools

The Standard option also installs an external Apache Cassandra database, which is used to store API Gateway and API Manager data. For more details, see Installation options.

For more details on API Gateway components and concepts, see the API Gateway Concepts Guide.

Before you begin

In preparation for a quick start installation, perform the following tasks:

  1. Check that your target system meets the system requirements. For more details, see Prerequisites.
  2. Download the installation setup file for your target system.
  3. Obtain the necessary license keys from your Axway Account Manager.


Locate and run the installation setup file. The installer launches in GUI mode by default. Follow the instructions on each window, accepting the default selections at each step. For more information on starting the installer, see Start installation.

When installation is complete, the Cassandra database, API Gateway instance, and Admin Node Manager processes are started, the QuickStart tutorial is launched in a browser window, and the Policy Studio desktop tool is started.


You can use the QuickStart tutorial to invoke some example APIs and to monitor the API Gateway using API Gateway Manager. For more information on using API Gateway Manager, see the API Gateway Administrator Guide.

You can use the Policy Studio desktop tool to virtualize APIs and develop policies (for example, to enforce security, compliance, and operational requirements). To begin developing policies in Policy Studio, you must first open or create a new project. For example, follow these steps to create a new project from a running API Gateway instance:

  1. When Policy Studio starts up, select File > New Project.
  2. In the New Project dialog, enter a name for the project and click Next.
  3. Select From a running API Gateway instance and click Next.
  4. In the Open Connection dialog, select the Admin Node Manager session to connect to, enter the administrator user name and password that you specified during installation and click OK.
  5. In the Download Options dialog, select the group and the instance to download its configuration.
  6. Click Finish.

For more information on using Policy Studio, see the API Gateway Policy Developer Guide.

Related Links