API Gateway Deployment

Connecting to an External Elasticsearch

Connecting to an External Kibana

API Gateway, Elasticsearch, Kibana Compatibility Matrix

Troubleshooting Tips: External Elasticsearch

You can deploy API Gateway in two editions based on the type of license used:

API Gateway: Standard Edition. This edition of API Gateway offers only API protection.

API Gateway: Advanced Edition. This edition of API Gateway offers both API protection and mediation capabilities.

You can view the type of license by selecting Username > About. The information is displayed under Product Information section. You can change the type of license at any time from the Standard Edition to the Advanced Edition.

Note:
For details about API Gateway License management see, webMethods Integration Server Administrator’s Guide

This table lists the capabilities available in the Standard and the Advanced Editions of API Gateway.

Feature	Standard Edition	Advanced Edition
Users and Roles	Administrators	Administrators and API Provider
Administration Ports License management Load balancing Keystore configuration	Yes	Yes
Administration Extended settings	No	Yes
Alias management	No	Yes
Service management	No	Yes
Policy management Threat protection rules	Yes	Yes
Policy management Global policies Policy templates	No	Yes
Export and Import APIs Global policies	No	Yes
Application management	No	Yes
Plans and packages	No	Yes
Analytics Threat protection rule violations	Yes	Yes
Analytics Service Applications Consumers	No	Yes
Clustering and auto synchronization	No	Yes

API Gateway Components

A basic API Gateway setup consists of following three components:

API Gateway. The API Gateway component consists of the API Gateway server that provides the API Gateway core functionality and the API Gateway UI.

API Data Store (Elasticsearch). API Gateway installation bundles a default Elasticsearch, which is called as API Data Store and all the data by default is written to this Elasticsearch. API Gateway uses Elasticsearch as its primary data store for persisting different types of data. These data are classified as follows:

Assets (such as APIs, policies, and applications)

Configuration data

Runtime data

Application and audit logs

Kibana. Kibana is a data visualization dashboard software that works with Elasticsearch. It provides search and data visualization capabilities for the data indexed in Elasticsearch. API Gateway installation bundles a default Kibana. As Kibana and Elasticsearch have a one-to-one mapping, API Gateway provides an option to configure external Kibana.

By default, all the three components are bundled together. In this embedded deployment when you start the API Gateway instance, by default the API Data Store and Kibana gets started automatically.

If you want to scale Elasticsearch and Kibana independently, you can install and run them separately in a distributed environment by configuring external Elasticsearch and external Kibana.