API Management versions 7.5.X and 7.6.X have reached end of support in November 2020.
Check out the latest version of the documentation.

Install the QuickStart tutorial

The API Gateway QuickStart tutorial is available on Linux. It demonstrates the main API Gateway features and tools, and enables you to invoke some example APIs and to monitor API Gateway using API Gateway Manager.

Tip   The QuickStart tutorial is automatically installed as part of a default Standard or Complete setup. For more details, For more details, see Installation options.


Ensure that all of the prerequisites detailed in Prerequisites are met.

Install the QuickStart tutorial

Note   The QuickStart tutorial is dependent on the API Gateway Server. You cannot install the QuickStart tutorial without the API Gateway Server.

To install the API Gateway Server and the QuickStart tutorial in GUI mode, perform an installation following the steps described in Installation options, using the following selections:

  • Select the Custom setup type.
  • Select to install the API Gateway Server, Admin Node Manager, and QuickStart tutorial components.

To install the API Gateway Server, Admin Node Manager, and QuickStart tutorial in unattended mode, follow the steps described in Unattended installation.

The following example shows how to install the API Gateway Server component and the QuickStart tutorial in unattended mode:

APIGateway_7.6.2_Install_linux-x86-32_BN20200714.run --mode unattended 
--setup_type advanced 
--enable-components apigateway,nodemanager,qstart 
--licenseFilePath mylicense.lic

QuickStart domain configuration

When the QuickStart tutorial is installed, a sample API Gateway domain is automatically configured in your installation. This includes a QuickStart Server API Gateway instance that runs in a QuickStart Group group. The QuickStart server and Admin Node Manager start automatically when installation is complete.

Start the QuickStart tutorial

The QuickStart tutorial launches automatically in your browser when installation is complete. Follow the instructions in your browser to perform the steps in the tutorial.

For example, the following screen shows invoking a sample API in the tutorial:

QuickStart Overview

You can click the Try it button to invoke the sample API. This displays a JSON list of available products. You can click the Show Me button to view the traffic monitored by API Gateway in API Gateway Manager.

Restart the QuickStart tutorial

At any point, if you need to restart the QuickStart tutorial, perform the following steps:

  1. Open a command prompt in the following directory:
  2. INSTALL_DIR/apigateway/posix/bin
  3. Run the startinstance command, for example:
  4. startinstance -n "QuickStart Server" -g "QuickStart Group"
    Note   You must ensure that the startinstance has execute permissions.
  5. To manage and monitor the API Gateway, you must ensure that the Admin Node Manager is running. Use the nodemanager command to start the Admin Node Manager from the same directory.
  6. To launch API Gateway Manager, enter the following address in your browser:
  8. Enter the administrator user name and password. This is the administrator user name and password you entered during installation.
  9. To launch the QuickStart tutorial, enter the following address in your browser:

Related Links