Managing Gateway instances
The Configure Server > Gateways page is the central hub for adding and managing your API Gateways. The Gateways & Environments tab allows you to toggle between enabled and deleted API Gateways. The table on the Gateways & Environments page provides operational details for each API Gateway your account has access to:
- Status: The current operational status of the Gateway. The Status column uses icons to indicate the current operational state. For a complete description of each icon, refer to Status icons.
- Issues: Displays warnings or errors pertinent to the API Gateway. In the Issues column, no information appears unless there is an error or warning relevant to the API Gateway. For a complete description of each icon, refer to Issues icons.
- Gateway Name: The name assigned to the API Gateway.
- Environments: The Environments currently attached to the API Gateway.
- Host Name: The host machine name where you install the Gateway.
- Gateway URL: The URL used to access the Gateway.
The table is sortable by Status, Gateway Name, Host Name, and Gateway URL. You can use the search field to filter the table by API Gateway or environment name.
API Gateway status and monitoring
API Gateways constantly report their status back to the platform. Status information displays in the Status and Issues columns of the management table.
Status icons
The Status column uses icons to indicate the current operational state:
| Icon | Description |
|---|---|
 Starting | The API Gateway is starting. |
 Online | The API Gateway is online and is communicating with the platform. |
| Stopping | The API Gateway is stopping. |
| Restarting | The API Gateway is restarting. |
 Restarting | The API Gateway is restarting, but it has not responded within five minutes (if the Force Restart value is not set on the Properties panel) or within one minute over the Force Restart value (if the Force Restart value is set on the Properties panel). |
 Offline | The API Gateway is not running. |
 Offline | The API Gateway is not running, but it did not shut down cleanly. |
| Offline | The API Gateway was attempting to start, but it has not started. |
 Offline | The API Gateway stopped communicating with the platform and may have terminated unexpectedly. |
| Cluster Issues | Cluster issues are affecting the operation of the API Gateway. Information about the issues is provided in the Issues column. |
 Deleted | If you are toggled to the Deleted view, the Gateway is deleted. |
Issues icons
The Issues column displays errors or warnings. Issues do not appear on deleted Gateways.
| Icon | Description |
|---|---|
| Error | The API Gateway encountered an error. Details about the error can be obtained by clicking the link. |
| Warning | A condition necessitating a warning is affecting the operation of the API Gateway. The warning can be obtained by clicking the link. |
If an error or warning occurs, the corresponding icon appears in both the Status and Issues columns.
Gateway settings
Clicking an API Gateway Name opens its settings page. Refer to API Gateway configuration and settings to view all the information available on this page.
Connecting Gateways to Environments
API Gateways are linked to Environments to define and manage how API requests are routed to specific Boomi processes.
Clicking the Environment for an API Gateway opens the Environment Configuration page for that environment. In that page, you can configure the URL paths to access APIs on that environment through the API Gateway. For more information, refer to Environment configuration.
The last row of the APIs table on the Gateways page displays environments that are not attached to any API Gateway. If more than three unattached environments exist, only the first three are shown by default. Clicking See more… expands the list to show all unattached environments. Selecting any unattached environment opens its Environment Configuration page.
