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

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Back up all databases in your API Manager instances along with the synapse configs of all the tenants and super tenant.
    You find the synapse configs of the super tenant in the <CURRENT_API-M_HOME>/repository/deployment/server/synapse-configs/default directory. Synapse configs of tenants are in the <CURRENT_API-M_HOME>/repository/tenants directory. 
    If you use a clustered/distributed API Manager setup, back up the available configurations in the API Gateway node.

  2. Download API Manager 2.0.0 from
  3. Open the <API-M_2.0.0_HOME>/repository/conf/datasources/master-datasources.xml file and provide the datasource configurations for the following databases. You can copy the configuration values from the same file in the current API Manager instance already being used.

    • User Store
    • Registry database/s
    • API Manager Databases
  4. Edit the registry configurations in the <API-M_2.0.0_HOME>/repository/conf/registry.xml file and the user database in the <API-M_2.0.0_HOME>/repository/conf/user-mgt.xml file similar to the configurations of the current API Manager.


    Note that in a clustered/distributed API Manager setup, step 5 and 6 need to be done on the Gateway node.

  5. Move all your synapse configurations except the files mentioned below by copying and replacing the <CURRENT_API-M_HOME>/repository/deployment/server/synapse-configs/default directory to the <API-M_2.0.0_HOME>/repository/deployment/server/synapse-configs/default. 


    NOTE: Do not replace the files listed below from the <CURRENT_API-M_HOME>/repository/deployment/server/synapse-configs/default folder to APIM 2.0.0. These are application-specific APIs and sequences. If you made any custom changes to the files below, please merge them to the corresponding files in 2.0.0.

    /api/_AuthorizeAPI_.xml /api/_RevokeAPI_.xml /api/_TokenAPI_.xml /api/_UserInfoAPI_.xml /sequences/_auth_failure_handler_.xml /sequences/_build_.xml /sequences/_cors_request_handler_.xml /sequences/fault.xml /sequences/main.xml /sequences/_production_key_error_.xml /sequences/_resource_mismatch_handler_.xml /sequences/_sandbox_key_error_.xml /sequences/_throttle_out_handler_.xml /sequences/_token_fault_.xml /proxy-services/WorkflowCallbackService.xml
  6. Move all your tenant synapse configurations by updating the configurations made in the <CURRENT_API-M_HOME>/repository/tenants directory to the <API-M_2.0.0_HOME>/repository/tenants directory.


    NOTE: Get the files listed below from the <API-M_2.0.0_HOME>/repository/deployment/server/synapse-configs/default/sequences directory and replace the corresponding files in the <API-M_2.0.0_HOME>/repository/tenants/<tenant-id>/synapse-configs/default/sequences directory.

    _auth_failure_handler_.xml _build_.xml _cors_request_handler_.xml fault.xml main.xml _production_key_error_.xml _resource_mismatch_handler_.xml _sandbox_key_error_.xml _throttle_out_handler_.xml _token_fault_.xml
  7. If you have documentation defined for your APIs, make sure you add a value to the Documentation Summary field. 
    Documentation summary is mandatory in APIM 2.0 onwards. Trying to migrate with an empty documentation summary field from an older version can cause issues in the migration. 

Upgrading the API Manager to 2.0.0