This topic describes various tasks that you might perform after installing API Gateway. This includes how to check if an installation has been successful, any initial configuration needed before you can start API Gateway, what you should do to secure API Gateway, and so on.

This topic includes the following:

Verify the installation

To verify your installation, follow these guidelines:

  • Check the installation results
  • Start API Gateway components
  • Log in to the API Gateway tools

Check the installation log

You can examine the installation log in the root directory of the installation (for example, Axway-installLog.log).

Start API Gateway components

Log in to the API Gateway tools

Initial configuration

Depending on the installation options you selected, the following tasks might need to be completed before you can start API Gateway.

Create a new domain

If you did not install the QuickStart tutorial, you must use the managedomain script to create a new managed domain that includes an API Gateway instance.

Note   This is required if you did not install the QuickStart tutorial.
Windows INSTALL_DIR\apigateway\Win32\bin
UNIX/Linux INSTALL_DIR/apigateway/posix/bin

For more details on running managedomain, see the API Gateway Administrator Guide.

Set up a database for API Gateway Analytics

If you installed API Gateway Analytics, you must set up a JDBC-compliant database, before you can start API Gateway Analytics:

  • First, you must install and configure a database to store the monitoring and transaction data read by API Gateway Analytics. See Configure the metrics database.
  • Next, you must configure API Gateway Analytics to use this database instead of the default (a MySQL database stored on the local machine). See Configure API Gateway Analytics.

Secure API Gateway

It is important to secure your API Gateway system as soon as possible after installation, to protect the API Gateway environment from internal or external threats.

Change default passwords

If you did not set an administrator user name and password during installation, you should change the default administrator user name and password now. For more details on managing administrator users, see the API Gateway Administrator Guide.

Change default certificates

The default certificates used to secure API Gateway components are self-signed. You can replace these self-signed certificates with certificates issued by a Certificate Authority (CA). For more information, see the API Gateway Administrator Guide.

Encrypt API Gateway configuration

By default, API Gateway configuration is unencrypted. You can specify a passphrase to encrypt API Gateway instance configuration. For more details, see the API Gateway Administrator Guide.

Run as non-root on UNIX/Linux

In a typical deployment on Linux or UNIX, the process for the API Gateway instance runs as root, to enable the API Gateway to listen on privileged ports. However, you can run the API Gateway process as a non-root user and still allow access to privileged ports. For more details, see the API Gateway Administrator Guide.

Set up services

This section explains how to run various components as services.

API Gateway

You can run Node Managers and API Gateway instances as services using the managedomain script. To register a Node Manager or an API Gateway instance as a service on UNIX/Linux or Windows, you must run the managedomain command as root on UNIX/Linux, or Administrator on Windows. For example:

  • Node Manager: Enter managedomain --menu, and choose option 2, Edit a host.
  • API Gateway instance: Enter managedomain --menu, and choose option 10, Add script or service for existing local API Gateway.

Alternatively, you can run managedomain in command mode with the --add_service option to create a service for a Node Manager or API Gateway instance.

For more details on managedomain, see the API Gateway Administrator Guide.

API Gateway Analytics

You can also run API Gateway Analytics as a service. On UNIX/Linux, you must create the script manually. A sample script and ReadMe is provided in the following directory:


On Windows, change to the following directory:


Enter the following command:

installservice.bat "C:\INSTALL_DIR\analytics" "Analytics" "7.5.3" analytics.xml

The command options are:

<"Installation Path"><"Name"><"Version"><Configuration File>

These options are explained as follows:

  • Installation Path: The path to and including API Gateway Analytics.
  • Name and Version: Used to name the Windows service.
  • Configuration File: This should almost always be analytics.xml. The installservice.bat script hard-codes system\conf to give the full path to the existing configuration file.

Apache Cassandra

For details on running Apache Cassandra as a service, see Install an Apache Cassandra database.

Set up clustering

To set up API Gateway for high availability, you need to configure an external Apache Cassandra database for clustering. For more information, see the following topics:

Next steps

Consult the API Gateway Administrator Guide for more information on administering, managing, and troubleshooting an API Gateway system. This guide contains many topics that you will find useful after installing API Gateway. For example:

  • Manage an API Gateway domain
  • Configure API Gateway for high availability
  • Backup and disaster recovery
  • Configure scheduled reports
  • Manage user access

Related Links