Managing Microgateways


This article explains how to manage Microgateways using API Gateway Cloud. Microgateway management includes monitoring the number of microgateways and the number of APIs that are available in the microgateway group.


It is assumed that readers of this article are familiar with usage of API Gateway and microgateway and its configuration.


  • Start API Gateway
  • Configure few APIs
  • Provision Microgateways using instance based or docker based provisioning

Use Case

The common usage of microservices and architectures based on microservices has increased the need for light weight gateways. The flexible deployment nature of Microgateway makes it ideal for low latency small footprint solutions.

Microgateway enables microservices to communicate with each other directly without the need for API Gateway. This eases the traffic overload on API Gateway and reduces the latency in the communication round trip. The required protection policies can be enforced on the Microgateway to establish a secure communication channel between the microservices.

Managing Microgateways

Click on API Gateway → Microgateways to open Microgateway management page.

Microgateway Groups

Microgateways displays groups of microgateways. Microgateways can be grouped by adding the below configuration to custom-settings.yml file.




If no pool name is provided Microgateway is added to Default group. Pool description is an optional field.

The Microgateway group page displays the following information,

  • Host name
  • HTTP and HTTPS port details
  • Description
  • Number of APIs available in Microgateway


Delete option can be used to delete a Microgateway from the group.

Microgateway Details

Microgateway details page provides information about Microgateway.

The Microgateway Info tab includes

  1. Basic Information about Microgateway like Name, Description, Version, Host, Port and Microgateway Pool name.
  2. API details – the details of the APIs provisioned in the Microgateway. Click on the API to see the endpoint details.


Microgateway Analytics

Microgateway Analytics page displays the analytic details of the data received in Microgateway.

The analytics page displays,

  • Overall Events – displays different category of events monitored. Ex: Performance Data, Error, Transactional, Policy Violation and Lifecycle events
  • Application Activity – Displays the details of applications invoking the APIs
  • Runtime Events – Displays the runtime event details such as, Time of the Event, api name, application name, event type, alert type, status, event source and alert description
  • Payload size - Displays the payload size of the request and responses

Each runtime event can be expanded by clicking on it to view further details.

Filters can be applied to view specific analytics data. Filters can be applied on duration, such as specific time or for a duration.


Filter queries can also be created by using Add Filter option.

APIs for Managing Microgateways

  • API to get list of assets deployed in microgateway - /rest/microgateway/assets
  • API to get settings of microgateway - /rest/microgateway/settings
  • API to get the status of microgateway - /rest/microgateway/status