Upgrading from a Previous Release

The following information describes how to upgrade your API Manager server from a previous release. Note that if you are upgrading from APIM 1.4.0, you must first upgrade to 1.5.0 before upgrading to 1.6.0.

Upgrading the database

1. Stop the API Manager server.
2. Run the migration script on the old database.

Note that you must select the script corresponding to your database type. For example, if your database is MySQL, execute mysql-migration.sql.

Upgrading APIM from 1.4.0 to 1.5.0

If your current version is APIM 1.4.0, follow these steps to upgrade to version 1.5.0 before upgrading to 1.6.0.

1. Download API Manager 1.5.0 from http://wso2.com/products/api-manager. 

2. Get the scripts that are relevant to upgrading APIM 1.4.0 to APIM 1.5.0 from here.
   Note that there are two directories containing two sets of scripts.

3. Execute the script that is relevant to your database in the migration-1.4.0_to_1.5.0/userstore_db directory.
   This script will migrate tables and data in your JDBC user store. For example, if your database is Oracle, execute the Oracle.sql script. 
4. Execute the script relevant to your database in the migration-1.4.0_to_1.5.0/apimgt_db directory.
   For example, if your database is Oracle, execute Oracle.sql in apimgt_db.

5. Connect APIM 1.5.0 to the migrated databases. Open the <AM 1.5.0_HOME>/repository/conf/user-mgt.xml file and add the following property to the existing <AuthorizationManager> configuration.

   <property name=“CaseSensitiveAuthorizationRules">true</property>

Upgrading APIM from 1.5.0 to 1.6.0

1. Download API Manager 1.6.0 from http://wso2.com/products/api-manager. 
   
2. Get the scripts for upgrading APIM 1.5.0 to APIM 1.6.0 from here.
3. Execute the script relevant to your database.
   For example, if your database is Oracle, execute Oracle.sql.
4. Point the same user manager/registry database that you migrated in APIM 1.5.0 to APIM 1.6.0.

You have now completed the data migration. The next step is to copy the configurations. 

Migrating the configurations

1. Copy the contents of your previous <APIM_HOME>/repository/deployment/server/synapse-configs/default directory to the same directory in the new version.
   

   When copying files, do not replace the following application-specific APIs: AuthorizeAPI.xml and TokenAPI.xml.

2. To migrate tenant configurations, copy the contents from your previous <APIM_HOME>/repository/tenants directory to the same directory in the new version. 
   

3. Start the API Manager and log in to the Management Console.
4. On the Extensions tab, click Artifact Types, and then click View/Edit in the api row.
   
5. Update the APIM.rxt file with the content found in /rxt/api.rxt.

6. Configure the endpoint-migration/build.xml using the following properties:
   
   

   Property	Description
   registry.home	Path to the APIM distribution. In a distributed setup, give the API Publisher node's path.
   username	Username for the server. For a tenant to log in, provide the tenant admin username.
   password	Password for the server. For a tenant to log in, provide the tenant admin password.
   host	IP of the running APIM server. In a distributed setup, give the host of the API Publisher node.
   port	Port of the running APIM server. In a distributed setup, give the port of the APIM Publisher node.
   version	Version of the server.

7. Go to endpoint-migration and execute the following command:

   ant run

   If the execution is successful, you will get a BUILD SUCCESSFUL message.