This documentation is for WSO2 API Manager 2.6.0. View documentation for the latest release.

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated based on using the installer

Prior to installing any WSO2 Carbon based product, it is necessary to have the appropriate prerequisite software installed on your systemAPI Manager, make sure that the appropriate prerequisites are available. Verify that the computer has the supported operating system and development platforms before starting the installation.


For more information on JDKs that WSO2 products are tested with, see Tested Operating Systems and JDKs

If you are using the product installer to install the product, by default, WSO2 API-M is installed with OpenJDK, which allows you to run the product as soon as it is installed.

Operating systems/

  • All WSO2 Carbon-based products are Java applications that can be run on any platform that is Oracle JDK 1.8 or OpenJDK 8 compliant


To use a different JDK,  point the  JAVA_HOME  environment variable to the new JDK. Make sure your JDK version is compatible with the WSO2 product.

  • If you are using the product's binary distribution to install the product (instead of the product installer), install JDK. Make sure your JDK version is  compatible with the WSO2 product .

  • All WSO2 Carbon-based products are generally compatible with most common DBMSs. The embedded H2 database is suitable for development, testing, and some production environments. For most enterprise production environments, however, we recommend you use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, MS SQL, etc. For more information, see Working with Databases. Additionally, we do not recommend the H2 database as a user store.

  • It is not recommended to use Apache DS in a production environment due to scalability issues. Instead, use an LDAP like OpenLDAP for user management.
  • On a production deployment, it is recommended that WSO2 products are installed on latest releases of RedHat Enterprise Linux or Ubuntu Server LTS.
  • For environments that WSO2 products are tested with, see Compatibility of WSO2 Products
  • To find out if this version of the product has issues running on your OS due to the JDK version, see see Known Incompatibilities.
  • If you have difficulty in setting up any WSO2 product in a specific platform or database, please contact us.
  • ...

    The following applications are required for running the WSO2 API Manager and its samples or for building from the source code. Mandatory installs are marked with *.

    5.5.0 or later
    If you use any other JMS provider (e.g., Apache Qpid), install any necessary libraries and/or components. ActiveMQ3.0.*




    Download Links

    Java SE Development Kit (JDK)*

    • OpenJDK 8
    • Oracle JDK 1.8.*


      Some updates of JDK 1.8 (for example, JDK1.8.0_151) are affected by a known issue related to GZIP decoding. Until this issue is fixed, we recommend one of the following approaches:

      • Use either JDK1.8.0_144 or JDK1.8.0_077 updates. We have verified that these versions are not affected by the known issue.
      • Alternatively, you can disable GZIP decoding for your product by following the steps given below. This will ensure that your product is not affected by the known issue.
        1. Open the catalina-server.xml file from the <APIM_HOME>/repository/conf/tomcat/ directory.
        2. Set the compression parameter (under each of the connector configurations) to false as shown below:

          Code Block
        3. Restart the server.


    Oracle JDK

    Apache ActiveMQ JMS Provider

    • To enable the product's JMS transport and try out JMS samples. The ActiveMQ client libraries must be installed in the product's classpath before you can enable the JMS transport.


    Apache Ant

    • To compile and run the product samples in <APIM_HOME>/samples.

    1.7.0 or later

    Apache Ant

    Apache Maven

    • To build the product from the source distribution (both JDK and Apache Maven are required). If you are installing by downloading and extracting the binary distribution instead of building from the source code, you do not need to install Maven.
    Apache Maven

    Web Browser

    • To access the Management Console. The Web browser must be JavaScript enabled to take full advantage of the Management console.

    On Windows Server 2003, you must not go below the medium security level in Internet Explorer 6.x.