Try WSO2 Cloud for Free
Sign in
Skip to end of metadata
Go to start of metadata

  1. Where is WSO2 API Cloud hosted?

    WSO2 API Cloud is hosted in the AWS US East data center. For compliance or performance reasons, paying customers can choose alternative locations for their API gateways in API Cloud. These include Canada, US West, Brazil (São Paulo), EU (Ireland), EU (Frankfurt), Singapore, Tokyo, Sydney, Seoul, Mumbai, and Beijing.

  2. How can I log into the Cloud's advanced Management Console?

    In most cases, default user interfaces are sufficient for your administrative tasks. However, there are some scenarios, such as adding new user roles, that require the use of the advanced Management Console. Such scenarios are indicated in the corresponding documentation articles.

    You can log into the API Gateway's advanced Management Console using the URL

  3. The backend web service does not match the API design that I expect. What should I do?

    You can extend the default message mediation sequence using mediators. The API Cloud comes with a powerful mediation engine that can transform and orchestrate API calls on the fly. See Change the Default Mediation Flow of API Requests.
  4. What type of mediators are supported by the API Cloud?

    See WSO2 Cloud Mediators.

  5. How can I secure the link between my backend services and the API Cloud?

  6. What properties can I retrieve from an API using a property mediator within a sequence?

    SYNAPSE_REST_API_VERSIONRetrieves the version of the API. E.g., 1.0.0.
    REST_SUB_REQUEST_PATHRetrieves the sub request with path and query parameters. E.g., "/CheckPhoneNumber?PhoneNumber=1234567&LicenseKey=0".
    REST_API_CONTEXT or api.ut.contextRetrieves the context of the API in the form /t/tenantDomain/context/version for an API. E.g., "/t/tenant/new/1.0.0".
    REST_FULL_REQUEST_PATHRetrieves the entire request path. E.g., "/t/tenant/new/1.0.0/CheckPhoneNumber?PhoneNumber=1234567&LicenseKey=0".


    :For example, "context".
    TRANSPORT_IN_NAMERetrieves the transport. For example, "https".
    SYNAPSE_REST_APIRetrieves the name of the API. For example, "".

    See this tutorial in the WSO2 ESB documentation, to get an idea on how you can use a property mediator within a sequence to change the default mediation flow of API requests. Also, see Property Mediator of the ESB documentation.

  7. How can I download the Public Certificate of the key used to sign the JWT Token sent to the backend in API Cloud?

    Each tenant in WSO2 Cloud has their own private key and it is used to sign the JWT token. Please follow the steps below to get the public certificate.

    1. First, go to the Cloud's advanced Management Console and login as your tenant admin.
    2. Click List under the Main > Manage > Keystores section.
    3. Click Public Key to download the Keystore's public key.

  8. How long does it take for a change done in the API Publisher to appear in the global API Gateways?

    It takes a maximum of 10 minutes for a change done in the API Publisher to appear in the global API Gateways. This is due to the artifact synchronizing task that runs every 10 minutes.

  9. How can I display multiple API versions in the API Store?

    Follow the steps below to show multiple versions of an API in the API Store.

    a. Login to the API Publisher.
    b. Go to the Management Console (
    c. If you are already logged into the API Publisher, you are automatically logged into the Management Console.
    d. Once you log in to the Management Console, navigate to the Browse > Resources section and locate the /_system/config/apimgt/applicationdata/tenant-conf.json file in the registry. This can also be done by searching for the /_system/config/apimgt/applicationdata/tenant-conf.json file directly in the Location field as shown below.

    e. Click Edit as text, add the following properties to the file and click Save Content.

  10. How can I find the API Gateway logs? 

    Follow the steps below,

     a. Log in to WSO2 API Cloud.

     b. Go to the API Cloud Admin dashboard (click Configure > Admin Dashboard).

     c. On the left navigator, click Log Analyzer > Live Log Viewer to view your recent logs on the WSO2 API Gateway.

    If you face any problems while using the Live Log Viewer, follow these solutions to get back to the stage:

    a. Access failure notification

    If you see an error message similar to the above in the Live Log Viewer,

        • Your current browser session might be corrupted due to some browser actions. Refresh the browser to view the logs.
        • Your browser session may have expired or cleared. Log out from the API Cloud and log in again.
        • It may take some time to retrieve the logs the first time. So if there are any corruptions during this interval, it may lead to this error message. Refresh the Live Log Viewer page and try again.

    b. Too many logs notification

    If you are getting an error similar to the above, it means that you have reached the maximum limit of log lines during your current session. The limit of the log lines is very large and sufficient for debugging.  Refresh your browser to view the latest logs.

  11. What content types are supported in API Cloud?

    API Cloud Gateway servers process requests and responses with the following content types. If you have a requirement to process payloads of other content types, send a support request to the WSO2 Cloud team. 
    • application/x-www-form-urlencoded
    • multipart/form-data
    • text/html
    • application/xml
    • text/xml
    • application/soap+xml
    • text/plain
    • application/json
    • application/vnd.api+json
    • application/json/badgerfish
    • text/javascript
  • No labels