Skip to Content

Cloud API gateway


The cloud API gateway, hosted by Jitterbit, handles these API Manager security features and tasks involved in accepting and processing API Manager API calls:

  • Traffic management
  • Authorization and access control
  • Rate limiting
  • API payload processing

The cloud API gateway is managed, maintained, and hosted by Harmony and does not require any configuration. API Manager security features are configured at the API level or security profile level and are cached on the API gateway, which are then referenced during API runtime as described below.

Cloud API gateway system architecture

This diagram displays the system architecture of a Custom API deployed using a cloud agent and the cloud API gateway:

diagram cutsom API cloud deployment pp

  1. An API consumer makes a call to the API located at the cloud API gateway.

  2. The cloud API gateway references the cached security profiles (if applicable) and API metadata to perform authentication and access control tasks. If access to the API is denied, the cloud API gateway will return an appropriate HTTP response and status to the API consumer. If access to the API is granted, the API request is routed to the messaging service, which routes requests for agent groups.

  3. The cloud agent receives the request from the messaging service.

  4. The cloud agent references the API operation specified during the Custom API configuration and triggers the deployed operation.

  5. The operation responds with an API payload consistent with the response type selected during the Custom API configuration.

  6. The API response payload is routed from the cloud agent back to the cloud API gateway, which extracts the API payload and sets the final HTTP response and status. The HTTP response and status is sent to the API consumer.


    Unless the operation being triggered by the API call is using Temporary Storage, the API response payload will remain on the agent for a maximum of two days. The API response payload will remain on the cloud API gateway for no longer than the API gateway timeout of 15 seconds.

  7. Runtime status information and logs of running operations are sent to the transaction logs database.


    Consumer data is not stored in the transaction logs database unless debug mode is enabled during Custom API configuration.