Get started with the API Gateway Appliance

This section describes how users of physical and virtual appliances can get started using their API Gateway Appliance, including how to:

  • Connect to consoles and user interfaces
  • Secure the applicance
  • Configure appliance settings
  • Configure API Gateway software

Connect to consoles and user interfaces

When you first start the appliance, the Appliance Console Menu is displayed. You can switch between this console and an operating system terminal console by using the key combination Alt+Function Key, where F1 is the Appliance Console Menu, and F2 through F6 are operating system terminals. For more information, see Switch between consoles.

Appliance Console Menu

The Appliance Console Menu enables you to:

  • Manage the appliance, for example, reboot or shut down the system, change the system time, or view system log files.
  • Harden and secure the appliance, for example, change the password or configure Linux audit framework.
  • Configure the appliance network settings, for example, change the IP address.
  • Access support tools, for example, enable remote support.

For more information on the Appliance Console Menu options, see Appliance console menu reference.

Web Administration Interface

The Web Administration Interface (WAI) is a web-based interface that enables you to administer many features of the API Gateway Appliance.

To connect to the Web Administration Interface:

  1. Determine the IP address of the appliance. From the Appliance Console Menu press N to select network settings and then press V to view the configuration.
  2. In a web browser, enter the following address:
  3. https://IP_ADDRESS:10000
  4. Enter the administrator user name and password.
Note    
  • The first time you log in to the Web Administration Interface using the default administrator account (user name admin) you are prompted to change the password and log in again using the new password.
  • On the AMI appliance the default administrator password is not set by default. You must set the password before you log in to the Web Administration Interface for the first time. For more information, see Connect to the Web Administration Interface on AMI.

For more information on using the Web Administration Interface, see Administer your appliance using the Web Administration Interface.

Terminal console

You can access an operating system terminal directly on the appliance or via SSH.

To access a terminal directly from a physical or virtual appliance:

  1. When viewing the Appliance Console Menu, press Alt+Function Key to access a terminal (function keys F2 through F6 are operating system terminals).
  2. Enter the administrator user name and password.
Note    
  • The first time you log in to the terminal using the default administrator account (user name admin) you are prompted to change the password.
  • You cannot log in to the terminal as root. Instead, use su - to switch to the root user after logging in.

To access a terminal over SSH:

  1. Use an SSH client to connect to the appliance IP address.
  2. Enter the administrator user name and password.
Note    
  • The first time you log in over SSH using the default administrator account (user name admin) you are prompted to change the password.
  • By default, you cannot log in as root over SSH. However, you can enable root SSH access from the Web Administration Interface. For more information, see Allow root SSH access.
  • On the AMI appliance, you must have a private key to log in over SSH. For more details, see Connect to AMI over SSH.

Secure the appliance

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

Follow these guidelines:

  • Change the default administrator user (user name admin) and root user passwords.
  • For security reasons, you must change the default passwords before you start using the system. For more information, see Change passwords.
  • Restrict access to the Web Administration Interface and SSH server.
  • To configure the Web Administration Interface and SSH server to only listen on an address that is part of a firewalled network, or are otherwise protected from external access, see Manage IP access and Manage SSH.
  • Change default certificates.
  • The default SSL certificate used for the Web Administration Interface is self-signed. This is only intended as a temporary certificate and is not recommended for use in a production environment. You can replace the self-signed certificate with a certificate issued by a Certificate Authority (CA). To change this certificate, see Configure WAI settings.

Configure appliance settings

Before you start using the API Gateway Appliance, there are a number of system settings you might wish to configure:

Configure API Gateway software

The API Gateway software is preinstalled on the appliance, however, some initial configuration is required before you can start using API Gateway. For more information, see Configure API Gateway on the appliance.

Common tasks

This section describes some common tasks that you might find useful when working with your API Gateway Appliance.

Open additional ports in the firewall

The appliance includes a firewall, which is enabled by default. The ports that are open by default are described in Default ports. If you add API Gateway instances, or if you want to use different ports for business or management traffic, you must open up additional ports. For more information, see Configure the Linux firewall and Linux firewall example use cases.

Note   If you are working with an AMI appliance, you also need to add any additional ports to the AWS security group. For more information, see Allow access to ports on AMI.

Related Links