Page Comparison

...

WSO2 API Manager is a complete solution for creating, publishing and managing all aspects of an API and its life cycle. See the For more information, see the introduction.

What is the open source license of the API Manager?

...

It is completely supported from evaluation to production. See For more details, see WSO2 Support.

What are the default ports opened in the API Manager?

See For a list of all default ports available, see Default Ports of WSO2 Products.

...

The API Manager is built on top of WSO2 Carbon, an OSGi based components framework for SOA. See For more details, see API Manager components.

Can I get involved in APIM development activities?

Not only are you allowed, but also encouraged. You can start by subscribing to dev@wso2.org and architecture@wso2.org mailing lists. Feel free to provide ideas, feedback and help make our code better. For more information on contacts, mailing lists and forums, see our support community page.

What is the default communication protocol of the API Manager?

The default communication protocol is Thrift.

Does WSO2 API-M support HTTP pipelining?

No, currently WSO2 API-M does not support HTTP pipelining.

...

Installation and start up

What are the minimum requirements needed to run WSO2 API Manager?

Minimum requirement is Oracle Java SE Development Kit (JDK). See Installation Prerequisites.

What Java versions are supported by the API Manager?

Oracle JDK versions 1.7.*/1.8.*.

Which MySQL database script should I use?

From Carbon kernel For a list of system requirements, environment compatibility and required applications, see Installation Prerequisites.

Which MySQL database script should I use?

From Carbon kernel 4.4.6 onward your product is shipped with two scripts for MySQL as follows  (click here to see if your product is based on this kernel version or newer):

...

Copy any third-party JARs to <APIM<API-M_HOME>/repository/components/lib directory and restart the server.

...

Can I connect the API Manager directly to an LDAP or Active Directory where

...

corporate identities are stored?

Yes. You , you can configure the API Manager with multiple user stores. See For m ore details, see Configuring User Stores.

Can I extend the management console UI to add custom UIs?

...

The memory allocation settings are stored in <APIMthe <API-M_HOME>/bin/wso2server.sh file.  

...

How do I start up only selected

...

components of the API Manager?

Even though the API Manager bundles all components together, you can select which component/(s) you want to start by using the -Dprofile command at product startup. See For more information, see Product Profiles for more information.

...

Deployment

...

What are the different deployment patterns and clustering configurations of the API Manager?

See Deploying WSO2 API Manager.

...

OpenShift, Docker, Kubernetes and Mesos are supported.

What is the recommended way to manage multiple artifacts in a product cluster?

For artifact governance and lifecycle management, we recommend you to use a shared WSO2 Governance Registry instance.

Is it recommended

...

to run multiple WSO2 products on a single server?

This is not recommended in a production environment involving multiple transactions. If you want to start several WSO2 products on a single server, you must change their default ports to avoid port conflicts. See Changing the Default Ports with Offset.

...

Yes, you can do this using the management console. The API Manager already has features of WSO2 Identity Server, WSO2 Governance Registry, WSO2 ESB etc. embedded in it. However, if you require more features of a certain product, it is recommended to use a separate instance of it rather than install its features to the API Manager.

...

Go to <API-M_HOME>/repository/conf/api-manager.xml. In the DataPublisher section, under ThrottlingConfiguration section, specify the username as follows: admin@wso2.com@carbon.super The api-manager.xml file only accepts only configurations for the super tenant.

<Username>admin@wso2.com@carbon.super</Username>

For more details, see Using Email Address as the Username.

...

How can I set up a reverse proxy server to pass server requests?

See Adding a Reverse Configuring the Proxy Server .and the Load Balancer.

...

Functionality

Why can't I

...

see all the APIs that I published on the API Store

...

?

If you have multiple versions of an API published, only the latest version is shown in the API Store. To display multiple versions, set the <DisplayMultipleVersions>  element to true in  <APIM in the <API-M_HOME>/repository/conf/api-manager.xml file.

When editing an API's resource

...

parameters, how can I add multiple options to

...

the Response Content

...

Type parameter?

You cannot do this using the UI.  InsteadInstead,   edit the  the Swagger definition of the API as  as shown in the following example,
content_type: ["text/xml","text/plain"]  for example.

Why are the changes I did to the

...

 Response Content

...

Type resource parameter of a published API not reflected in the API Store, even after saving?

If you edited the Response Content Type using the UI, please open the API's Swagger definition, do your changes, and save. Then the changes should be reflected back in the API Store. This will be fixed in a future release.

How

...

You can install any WSO2 component to the API Manager. See the Installing Features section in the WSO2 Carbon docs for more information.

How do I change the pass-through transport configurations?

...

do I change the pass-through transport configurations?

If you have enabled the pass-through transport, you can change its default configurations by adding the  following under the <transportReceiver name="https" class="org.apache.synapse.transport.passthru.PassThroughHttpSSLListener"> element in the  <PRODUCT_HOME>/repository/conf/axis2/axis2.xml file. Be sure to stop the server before editing the file.

...

<transportReceiver name="passthru-https" class="org.wso2.carbon.transport.passthru.PassThroughHttpSSLListener"> 
    <parameter name="HttpsProtocols">TLSv1,TLSv1.1,TLSv1.2</parameter> 
    ...... 
</transportReceiver>

...

How can I

...

extend the default API Manager server by installing new features

...

?

See Working with Features in the WSO2 Carbon documentationAdmin Guide.

How can I preserve the CDATA element tag in API responses?

Set the javax.xml.stream.isCoalescing property to false in the <APIM<API-M_HOME>/XMLInputFactory.properties file. Here's an example:

...

You can enable centralized authentication using a WSO2 Identity Server based security and identity gateway solution, which enables SSO (Single Sign On) across all the servers.

...

To set visibility of the API only to selected user roles in the server, see API Visibility.

How can I add security policies (UT, XACML, etc.) for the services?

This should be done in the backend services in the Application Server or WSO2 ESB.

...

See how to enable self signup.

How can I disable self signup

...

to the API Store? I want to engage my own approval mechanism.

To disable the self signup capability, open the APIM API-M management console and click the Resources - > Browse menu. The registry opens. Navigate to the /_system/governance/apimgt/applicationdata/sign-up-config.xml and set  file and set the <SelfSignUp><Enabled> element to false. To engage your own signup process, see Adding a User Signup Workflow.

Is there a way to lock a user's account after a certain number of failed login attempts to the API Store?

If your identity provider is WSO2 Identity Server, this facility comes out of the box. If not, install the Account Recovery and Credentials Management  feature (Available available under the User Management category) to the API Manager and configure it. For more information, see User Account Locking and Account Disabling page in  in the Identity Server documentation. For more information on installing features, see Feature Installation documentationWorking with features in the Admin Guide.

How do I change the default admin password and what files should I edit after changing it?

To change the default admin password, log in to the management console with admin/admin credentials and use the  "Change my password" option. After changing the password, do the following:

Change the following elements in <APIMin the <API-M_HOME>/repository/conf/api-manager.xml file:

<AuthManager>
   <Username>admin</Username>
   <Password>newpassword</Password>
</AuthManager>

<APIGateway>
   <Username>admin</Username>
   <Password>newpassword</Password>
</APIGateway>

<APIKeyManager>
   <Username>admin</Username>
   <Password>newpassword</Password>
</APIKeyManager>

Go to the  Resources - > Browse  menu in the management console to open the registry and update the credentials in  in the /_system/governance/apimgt/applicationdata/sign-up-config.xml registry location.

How can I recover the admin password used to log in to the management console?

Use <APIMthe <API-M_HOME>/bin/chpasswd.sh script.

...

To configure session timeouts, see Configuring the session time-out.

How can I add

...

authentication headers to

...

messages going out of the API Gateway to the backend?

Uncomment the <RemoveOAuthHeadersFromOutMessage> element in the <APIM<API-M_HOME>/repository/conf/api-manager.xml file and set its value to false.

...

<Password>
    <![CDATA[xnvYh?@VHAkc?qZ%Jv855&A4a,%M8B@h]]>
</Password> 

How

...

can I protect my product server from security attacks caused by weak ciphers?

You can protect your server from attacks such as the Logjam attack (Man-in-the-Middle attack)

...

You can disable weak ciphers as described in by disabling weak ciphers. For more details, see Disable weak ciphers in the WSO2 Carbon documentationAdmin Guide.

Troubleshooting

Anchor
priority priority

Why do I get

...

an illegal access attempt error while trying to authenticate APIKeyValidationService?

If you get the following error: org.wso2.carbon.server.admin.module.handler.AuthenticationHandler - Illegal access attempt

...

, it may be due to the following reasons,

• Did you change the default admin password?
  If so, you need to change the credentials stored in the <APIKeyValidator> element of the <APIM_HOME>/repository/conf/api-manager.xml file of the API Gateway node/s.

• Have you set the priority of the SAML2SSOAuthenticator handler higher than that of the BasicAuthenticator handler in the authenticators.xml file?
  If so, the SAML2SSOAuthenticator handler tries to manage the basic authentication requests as well. Set a lower priority to the SAML2SSOAuthenticator than the BasicAuthenticator handler as follows:

  Code Block
  language xml
  <Authenticator name="SAML2SSOAuthenticator" disabled="false"> <Priority>0</Priority> <Config> <Parameter name="LoginPage">/carbon/admin/login.jsp</Parameter> <Parameter name="ServiceProviderID">carbonServer</Parameter> <Parameter name="IdentityProviderSSOServiceURL">https://localhost:9444/samlsso</Parameter> <Parameter name="NameIDPolicyFormat">urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</Parameter> <Parameter name="ISAuthnReqSigned">false</Parameter> <!-<Parameter name="AssetionConsumerServiceURL">https://localhost:9443/acs</Parameter>-> </Config> </Authenticator>

How can I fix

...

a mismatching certificate hostname exception?

Reason for occurrence

The javax.net.ssl.SSLException: hostname in certificate didn't match: <ip addrees> != <localhost> exception is a very common exception that occurs whenever the WSO2 product server is accessed using a different IP address (e.g., https://10.100.0.77:9443/publisher) except localhost (e.g., https://localhost:9443/publisher).

The reason that the latter mentioned exception occurs is because the self-signed certificate that is shipped with WSO2 products is configured using the hostname as localhost, and as a result , Apache Shindig does not allow any other HTTP requests that originate from other hostnames/IP addresses other than localhost.

...

1. Open a terminal and type the following command to generate a KeyStore.

   Code Block
   keytool -genkey -alias test.foo.com -keyalg RSA -keystore foo.jks -keysize 2048

2. Anchor
   Keystorepassword Keystorepassword

   Specify a preferred KeyStore password when prompted.

   Code Block
   Enter keystore password: <keystore_password> Re-enter new password: <keystore_password>

3. Enter the first name and last name as *.foo.com and fill out the other information accordingly when prompted.

   Code Block
   title Example
   What is your first and last name? [Unknown]: <new_host_name> What is the name of your organizational unit? [Unknown]: What is the name of your organization? [Unknown]: WSO2 What is the name of your City or Locality? [Unknown]: Mountain View What is the name of your State or Province? [Unknown]: CA What is the two-letter country code for this unit? [Unknown]: US Is CN=*.foo.com, OU=Unknown, O=WSO2, L=Mountain View, ST=CA, C=US correct? [no]: yes

4. Specify a preferred private Key password when prompted.

   Code Block
   Enter key password for <keystore_password> (RETURN if same as keystore password): <key_password> Re-enter new password: <key_password>

   • <key_password> -  Enter the key password that you provided in step 1.2.

   This will generate generates a KeyStore with a private key and a public certificate with CN as *.foo.com

...

1. Copy the generated self-signed keystore, namely  foo.jks, which was created in step 1, into the <PRODUCT_HOME>/repository/resources/security directory.
2. Export the public certificate from the keystore and import that certificate to the client­-truststore.jks file.
   1. Navigate to the <API-M_HOME>/repository/resources/security directory.

   2. Export the public certificate from the primary KeyStore.

      Code Block
      keytool -export -alias test.foo.com -file test.foo.com -keystore foo.jks -storepass <KEYSTORE_PASSWORD_GIVEN_ABOVE>

   3. Import the certificate to the client­-truststore.jks file.

      Code Block
      keytool -import -alias test.foo.com -file test.foo.com -keystore client-truststore.jks -storepass wso2carbon

...

Step 4 - Configure the new key store

Update the <Password>, <KeyAlias>, <KeyPassword> values under the <KeyStore> field in the <API-M_HOME>/repository/conf/carbon.xml file based on your new key store configuration.

<KeyStore>
            <!-- Keystore file location-->
            <Location>${carbon.home}/repository/resources/security/foo.jks</Location>
            <!-- Keystore type (JKS/PKCS12 etc.)-->
            <Type>JKS</Type>
            <!-- Keystore password-->
            <Password><KEYSTORE_PASSWORD></Password>
            <!-- Private Key alias-->
            <KeyAlias><NAME_OF_THE_ALIAS></KeyAlias>
            <!-- Private Key password-->
            <KeyPassword><KEY_PASSWORD></KeyPassword>
        </KeyStore>

How can I fix

...

a fatal alert: unknown_ca error when invoking the methods of an API via the API Console?

The root cause for the javax.net.ssl.SSLException: Received fatal alert: unknown_

...

The root cause of this issue is ca error is because the default pack is not shipped with a CA-signed certificate. When using the API Console, the web browser sends an HTTPs request to the API Gateway. As the certificate on the Gateway is not CA-signed, the browser does not accept it.

To resolve this issue, first access the Gateway URL via a new browser tab of the same browser and accept the certificate from the browser. 

I hit the DentityExpansionLimit and it gives an error

...

while getting Recently Added APIs Information. What is the cause of this?

The {org.wso2.carbon.apimgt.hostobjects.APIStoreHostObject} - Error while getting Recently Added APIs Information

...

This error occurs in JDK 1.7.0_45 and is fixed in from JDK 1.7.0_51 onwards. See here for details of the bug.

...

Set the <parameter name="HostnameVerifier"> element to AllowAll in <APIM<API-M_HOME>/repository/conf/axis2/axis2.xml file's HTTPS transport sender configuration. For example, <parameter name="HostnameVerifier">AllowAll</parameter>.

This parameter verifies the hostname of the certificate of a server when the API Manager acts as a client and does outbound service calls.

When I add new users or roles, I get an error message

...

stating that the entered user name is not conforming to policy

...

. What should I do?

This is because your user name or password length or any other parameter is not conforming to the RegEx configurations of the user store. See Managing Users and Roles.

When I call a REST API,

...

a lot of temporary files are created in my server and

...

takes up a lot of space. What should I do?

There might be multiple configuration context objects created per each API invocation. Please check Check whether your client is creating creates a configuration context object per each API invocation. Also,  You can also configure a HouseKeeping task in the <APIM<API-M_HOME>/repository/conf/carbon.xml file to clear the temporary folders. For example.,

<HouseKeeping> 
        <AutoStart>true</AutoStart> 
        
        <!-- The interval in *minutes*, between house-keeping runs --> 
        <Interval>10</Interval> 

        <!-- The maximum time in *minutes*, temp files are allowed to live in the system. Files/directories which were modified more than 
         "MaxTempFileLifetime" minutes ago will be removed by the house-keeping task --> 
        <MaxTempFileLifetime>30</MaxTempFileLifetime>
</HouseKeeping>

Why do I get

...

a Gateway Failures error?

The Gateway Failures UI error occurs when the ServerURL, username, password and/or GatewayEndpoint is incorrect. This can be rectified by checking and correcting the latter mentioned gateway configurations under <Environments> in the <API-M>/repository/conf/api-manager.xml file. 

How can I capture the state of a system?

You can use the tool named Carbon Dump. At the time of an error, you can use a tool called Carbon Dump Dump (carbondump.sh) to collect all the necessary data (i.e., heap and thread dumps) from a running WSO2 API Manager instance in order to carryout a head dump and thread stack analysis. For more information on using this tool, see Capturing the state of the system in the Administration guide.

General questions

Can I implement an API facade with the API Manager?

You can use the API Manager and WSO2 ESB to implement an API facade architecture pattern. WSO2 recommends this architecture if you are performing heavy mediation in your setup. For implementation details of an API facade, see implementing an API facade with WSO2 API management platform.

As the API Manager does not have the ESB's GUI to perform mediation functions, you need to use the XML-based source view for configuration. Alternatively, you can create the necessary mediation sequences using the GUI of the ESB, and copy them from the ESB to the API Manager.

In addition, see the following use cases in WSO2 ESB documentation for more information on REST to SOAP conversion.

How can I write automated test scripts for the API Manager?

Use WSO2 Test Automation Framework (TAF) as explained in Writing a Test Case for API Manager.

Does WSO2 API-M support HTTP pipelining?

No, currently WSO2 API-M does not support HTTP pipelining.