Skip to content

Customize the API Store Domain

Customizing the API Store domain makes your API store easier to find. It is a quick and efficient way to differentiate your API Store from all the other API Stores in WSO2 Cloud. Moreover, your company domain is an important part of your developer community experience because subscribers enter the API Store domain into a browser to get to your API Store.

Follow the steps below to customize the API Store domain:

  1. Sign in to WSO2 API Cloud ( ) as an admin user.

  2. On the API Publisher, click Configure and then select Custom URL from the drop-down menu.
    This displays the Manage Custom Domains page.

  3. Under API Portal , click the pencil icon to edit the existing Custom Domain of the Store .

    This displays the Modify Store Custom Domain dialog box where you can specify a custom Domain Name for the Store.

  4. Specify a valid Domain Name and click Verify . This checks whether the CNAME record exists for the specified URL.

    If the CNAME verification is successful, you will see the following dialog box:

  5. For each field, upload a valid file that satisfies the specified requirements.

    Field Requirements
    SSL Certificate This certificate file must satisfy the following requirements:
    • Should be in X509 format.

    • Should not be expired.

    • Should be issued directly or by a wild card entry for a provided custom URL. For example,

      • In the direct method, if the CNAME is, the issued SSL file must contain

      • In the wildcard method, if the CNAME is, the issued SSL file should be *

    SSL Key File The private key of the certificate, which should be encrypted in the RSA format.
    Chain File The chain file to be used if the SSL connection to your custom URL fails with the SSL Certificate and SSL Key File .

  6. Click Proceed. If the certificate files upload successfully, you will see a notification similar to the following:

    This confirms that you have successfully changed the API Store domain name.


    It takes approximately 10 minutes for the changes to apply. Adding the configurations and restarting the load balancers can take some time.

  7. Access the API Store using your new URL. In this example, the new API Store URL is

Customize the API Store domain