This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Page Comparison - Integrating with WSO2 Governance Registry (v.2 vs v.3) - API Manager 1.8.0 - WSO2 Documentation

Versions Compared


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


  1. Download both WSO2 Governance Registry (G-Reg) and WSO2 API Manager.

  2. Provide the API Manager credentials in <GREG_HOME>/repository/resources/lifecycles/configurations.xml file. For example, the following code block defines an execution element in production state. It provides the API Manager's endpoint, username and password as executor parameters.

    Code Block
    <execution forEvent="Publish" class="org.wso2.carbon.governance.registry.extensions.executors.apistore.ApiStoreExecutor">
       <parameter name="apim.endpoint" value="http://localhost:9763/"/>
       <parameter name="apim.username" value="admin"/>
       <parameter name="apim.password" value="admin"/>
       <parameter name="default.tier" value="Unlimited"/>
       <parameter name="throttlingTier" value="Unlimited,Unlimited,Unlimited,Unlimited,Unlimited"/>

    Note: If you started the G-Reg server at least once before executing step 2, editing the configurations.xml file and restarting the server does not apply the configurations. You need to add the configurations using the G-Reg management console as follows:

    1. Log in to the G-Reg Management console and select Extensions -> Configure -> Lifecycles menu.
    2. Click the Edit link associated with ServiceLifeCycle .
    3. Add the configuration given in step 2 above and Save.
  3. Run the G-Reg and the API Manager.

    When running more than one WSO2 products on the same server, change the default port of one product to avoid port conflicts. You can do this by changing the <offset> value of one product in <PRODUCT_HOME>/repository/conf/carbon.xml file. In this example, we set the port offset value of Governance Registry to 1 as follows: <Offset>1</Offset>


    Note: If you offset the default API Manager port, you must also change the default API endpoints and the Thrift port accordingly. See Changing the Default Ports (with Offset).

  4. Access the API Manager server using the following URL: https://<HostName>:9443/carbon. As you changed the default port of G-Reg, you can access the server using the following URL: https://<HostName>:<9443+offset>/carbon.

  5. Log in to the G-Reg management console and create a new service in it and attach the default service lifecycle to it. For instructions on how to add a new service and associate a new lifecycle, see in the Governance Registry documentation.     

  6. Promote the service until it gets to the production state.     

  7. When it is in the production state, publish it using the Publish button. You should get a confirmation message once the API is successfully published.

  8. You have now created an API using a service in the Governance Registry. Open the API Publisher to see that this service is successfully created as an API.


    Use Secure Vault to secure the API Manager username and Password in a production deployment. See Adding API Manager username and password to secure vault.

Add the API Manager username and password to secure vault

  1. Run with -Dconfigure parameter.
  2. Add apim.username and apim.password as aliases to
  3. Run (on Linux) or cipertool.bat (on Windows) and encrypt username and password values.
  4. Add the encrypted text to file after the other ailas and encrypted pairs and restart the server. For example,

    Code Blockapim.username=klVWQ32mbNKBxiRp78kK1Et7ZDnLPEsFQTwYjNEzTdpYAISFWJht4cqMjtQ6sXRc7eubuFxBaGVYP6LBA33XjIc855a+kDiJKXjtGhcCejyHrZoKrHb2PCJ2y0TDWtczEfHHFMhn/0u+AJafU47HyOgBXZDLcbfGiC5mdJqEoj4= apim.password=klVWQ32mbNKBxiRp78kK1Et7ZDnLPEsFQTwYjNEzTdpYAISFWJht4cqMjtQ6sXRc7eubuFxBaGVYP6LBA33XjIc855a+kDiJKXjtGhcCejyHrZoKrHb2PCJ2y0TDWtczEfHHFMhn/0u+AJafU47HyOgBXZDLcbfGiC5mdJqEoj4=