About this Release

WSO2 API Manager is a platform for creating, managing, consuming, and monitoring APIs. It employs proven SOA best practices to solve a wide range of API management challenges such as API provisioning, API governance, API security, and API monitoring. It combines some of the most powerful and mature components of the WSO2's state-of-the-art Carbon platform to deliver a smooth and end-to-end API management experience while catering to both API publisher and API consumer requirements.

WSO2 API Manager comprises of the following modules:

  • Publisher Portal: Define new APIs and manage them.
  • Developer Portal: Browse published APIs and subscribe to them.
  • API Gateway: The underlying API runtime based on WSO2 Enterprise Integrator (WSO2 EI) 6.6.0
  • API Key Manager: Performs key generation and key validation functionalities.
  • API Traffic Manager: Performs rate limiting of API requests.

For more information on WSO2 API Manager, see the overview in the WSO2 API Manager 3.1.0 documentation and go to the product page on WSO2 API Manager on the WSO2 website.

What is new in this release

The WSO2 API Manager 3.1.0 is the latest WSO2 API Manager release and is the successor of WSO2 API Manager 3.0.0. It contains the following new features and enhancements:

  • Integrating AWS Lambda with APIM

    When using AWS Lambda to create and publish APIs, you can execute your code without having to manage or provision servers.

  • API Security Audit Integration

    WSO2 API-M has partnered with 42Crunch, which is the only enterprise API security platform, in order to be able to conduct a security audit on the OpenAPI Specification definition and to obtain an audit report.

  • API Categories

    API categories are similar to Tag wise grouping. However, admins need to define API categories that Publishers can use when creating APIs. Furthermore, unlike Tag wise grouping API categories do not use a naming convention. Therefore, with the introduction of this feature, WSO2 has deprecated the Tag wise grouping feature.

  • API Mocking

    Ability to create a prototype API using a mock payload that is generated for inline scripts.

  • PDF Report Generation

    Many users have constantly requested for the feature that enables reported based on statistical data to be generated. The first cut of the implementation of this feature has been included in this release, and it enables users to generate the Monthly API Usage Report.

    Users can select the year and month of their choice and generate the Monthly API Usage Report via the API-M Admin dashboard. Furthermore, the default implementation of this feature can be extended if the organization that the user is attached to requires different data than the ones provided by the default report.

  • Widget generator tool

    In addition to the default widgets that are shipped with the analytics dashboards, the Widget generator tool makes it easier to implement your own custom widget and use them across the dashboards. The widget generator tool automatically generates the widget skeleton by taking into account the user preferences via a command-line tool and guides the user until the widget is deployed in the dashboard.

  • GraphQL Analytics

    GraphQL Analytics requirements differ from standard API analytics. The existing charts have been improved to be able to view statistics for GraphQL operations. A single API call for a GraphQL API can have multiple operations associated with it. In this release, analytics charts will have the in-built capability to filter these API calls by GraphQL operation.

What has changed in this release

Improvements to existing WSO2 API-M features

  • Language Switch

    A language switch allows the Developer Portal users to select the language in which they want to read the content. The Developer Portal theming architecture lets developers to add a language switch in different ways.

  • Changing the layout direction in the Developer Portal

    You can switch the Developer Portal layout direction from its default LTR to RTL using a single configuration.

  • Custom URL feature improvements

  • Tracing feature improvements

  • Multiple JWT issuer support

Improvements to existing WSO2 API-M features

  • Custom data publishing via a sequence

    The Gateway component publishes attributes related to each API call to the WSO2 API-M Analytics Server. These details are published in the form of events and then summarized and persisted in the database. But all the information related to the request is not published to the Analytics Server by default. This feature allows you to publish custom attributes related to an API call for later analysis. Based on your requirement, you can engage a custom mediation sequence in the request or response path.

  • White labeling dashboard for tenants

    This feature provides the system admins an easier approach to white label the analytics dashboard by changing the logo image and the favicon. The system admin does not need to have React, CSS, or HTML knowledge to do this customization. All you need to do is to place the required images inside the respective tenant folder and update the directives in the configuration file so that the server will pick those directives and display the respective images based on the tenant who is currently logged in to the system.

Deprecated features and functionalities

  • Tag wise grouping

    API categories are used for API grouping, similar to Tag wise grouping. However, the user does not have to go through the hassle of following a naming convention when creating API categories. Therefore, with the introduction of the API categories, Tag wise grouping has been deprecated, and WSO2 recommends users to use the

  • Developer Portal and Publisher v0.15 based REST APIs.

Removed features and functionalities

Compatible WSO2 product versions

WSO2 API-M 3.1.0 is based on WSO2 Carbon 4.6.0 and is expected to be compatible with any of the WSO2 products that are based on any Carbon 4.6.x version, except when using WSO2 Identity Server as a Key Manager, you need to specifically use WSO2 Identity Server 5.10.0 when working with WSO2 API-M 3.1.0. If you get any compatibility issues, please contact team WSO2. For information on the third-party software required with API-M 3.1.0, see Installation Prerequisites. For more information on the products in each Carbon platform release, see the Release Matrix.

Fixed issues

Known issues

What has changed

  • API-M from 3.1.0 onwards supports only pdf, doc and txt type files as file typed API documents by default. If you wish to support other document types, please add the below config to deployment.toml.


    supported_document_types = "<DOCUMENT TYPES LIST>"


    supported_document_types = "pdf, txt, zip, json, yaml"

  • From API-M 3.1.0 onwards, tag-wise grouping has been deprecated. Users are informed to use API category based grouping instead.

  • New user store managers with inbuilt unique ID support was introduced in WSO2 5.10.0 and named with the UniqueID prefix. User store managers that do not have UniqueID as part of the user store manager name are only available for backward compatibility purposes and can only be used if you are migrating from a previous version of WSO2 Identity Server.

Contact the WSO2 Support Team to obtain information on Migration of user store managers with unique ID support for more information.