2.5 Create the API Gateway

Access Manager Administration Console > Dashboard > API Gateway Cluster

After you create the API Gateway cluster, you then create one or more API Gateways in the cluster. You create the API Gateway by adding the DNS name or IP address of the appliance or Docker container. If you deployed the appliance, you must set a password for the vaadmin account on the appliance.

You must create or import a certificate in the Access Manager certificate management service to be able to create the API Gateway in the Administration Console. Secure API Manager requires SSL communications between the API Gateway and Access Manager. The certificate allows Secure API Manager to automatically configure the SSL communication channel between the API Gateway and Access Manager.

IMPORTANT:Secure API Manager does not work if you configure an API Gateway in more than one API Gateway cluster. Ensure that you add the API Gateway only once to an API Gateway cluster. Also, ensure that you either use an IP address or a DNS name. Do not use both options during the configuration of the API Gateway.

To create the API Gateway:

  1. On the Dashboard, click the appropriate API Gateway cluster.

  2. Click New Gateway.

  3. Use the following information to configure the API Gateway:

    Display Name

    Specify a name for the API Gateway to display in the Administration Console.

    Protocol

    Select whether you want components to communicate over http or https.

    Hostname

    Specify the fully qualified DNS name or IP address of the appliance or Docker container.

    Port

    Specify 443 for the port. Secure API Manager listens on 443 for any traffic from the API Gateway.

    Gateway Admin Name

    Specify the name of the administrative account you configured when you deployed the API Gateway.

    Gateway Admin Password

    Specify the administrator password for the API Gateway.

    Gateway TLS Keypair certificate

    Click Select Certificate to select the SSL certificate that you created or uploaded to the Access Manager certificate management system to use with this API Gateway. Secure API Manager sends the selected certificate from the Access Manager certificate management system to the API Gateway. The API Gateway uses the information in the certificate as its new Public/Private keypair information for secure connections.

  4. Select whether you want to save the certificate, then click Yes or No. If you select No, the configuration of the API Gateway stops.

    IMPORTANT:You must have a valid certificate to create an API Gateway.

  5. (Conditional) If you are clustering the API Gateway, repeat Step 1 through Step 4 for each node in the cluster.