Skip to main content


Add a Gateway Instance

A gateway instance is a single proxy that handles traffic. Gateway instances belong to gateway groups. This document describes how to add a gateway instance to a gateway group using any of the following methods:

  • Docker
  • Kubernetes


  1. Obtain a user account with Super Admin or Runtime Admin role.
  2. Add a gateway group. This tutorial assumes that you have created a gateway group named Production.
  3. Install Docker if you add a gateway instance using Docker.
  4. Install Helm and Kubernetes if you add a gateway instance using Kubernetes.


If you use a platform like OpenShift, you need to grant API7 Enterprise Security Context Constraints (SCC) in advance.



  1. Click the Production gateway group and then click Add Gateway Instance.
  2. Follow the instructions on the page to perform the following operations.
    • Set the HTTP port ID and HTTPS port ID to 9080 and 9443 respectively.
    • (Optional) set the gateway instance name to test.
  3. Click Generate to get the commands that are used to add the gateway instance to the Production gateway group.
  4. Open a terminal and run the generated commands. Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.


API7 Cloud

SOC2 Type IRed Herring

Copyright © APISEVEN Ltd. 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation