Gateway Components

Apiman is made up of a number of different components, many of which can be configured to use different implementations and/or providers.

When downloading and installing Apiman, the default distribution includes reasonable default values, but you can pick-and-choose components to match your needs.

  • Refer to your platform’s configuration documentation, or the corresponding component configuration documentation for comprehensive information.

  • You can implement your own components to provide tightly integrated functionality with your platform, or if you need custom semantics.

API Gateway Registry

The API Gateway includes a registry that stores the published API and Client App information.

This registry is updated whenever a user publishes an API (or registers a Client App) from the Apiman Manager.

The registry contains only the information necessary for the API Gateway to apply the configured policies to requests transiting the gateway [1].

Rate Limiter

The rate limiter component is used by Apiman policies to enforce rate limits and quotas, and uses the specified implementation to store data.

Different implementations have different semantic and performance characteristics.

Shared State

The shared state component is used by Apiman policies to share interesting state information across multiple requests.

Cache Store

Cache data on Apiman instead of hitting real back end.


Apiman has a metrics engine that collects a variety of valuable data before passing it to a pluggable metrics component.

Metrics implementations complete control in processing and transmitting data to external systems.

1. The Apiman Gateway Registry contains a subset of the information stored in the Apiman Manager.