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

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
When you run multiple WSO2 products/clusters or multiple instances of the same product on the same server or virtual machines (VMs), you must change their default ports with an offset value to avoid port conflicts. An offset defines the number by which all ports in the runtime (e.g., HTTP/S ports) will be increased. For example, if the default HTTP port is 9763 and the offset is 1, the effective HTTP port will change to 9764. For each additional WSO2 product instance, you set the port offset to a unique value. The offset of the default ports port is considered to be 0.

There are two ways to set an offset to a port:


Code Block
<address uri="https://localhost:9445/store/site/blocks/workflow/workflow-listener/ajax/workflow-listener.jag" format="rest"/>

Changing the Inbound web socket port


With API Manager 2.1.0, you can create and Publish websocket APIs. The default port used for websocket APIs is port 9099. 

If you are using multiple API Manager nodes with port offset in distributed mode, you have to change the in  <APIM_HOME>/repository/deployment/server/synapse-configs/default/inbound-endpoints/WebSocketInboundEndpoint.xml  by increment with the same offset that you used in <APIM_HOME>/repository/conf/carbon.xml.

E.g. If your carbon.xml has Offset value 2, WebSocketInboundEndpoint.xml should have  value 9101.


Code Block
<inboundEndpoint xmlns=""
      <parameter name="">9099</parameter>
      <parameter name="ws.outflow.dispatch.sequence">outDispatchSeq</parameter>
      <parameter name="ws.pipeline.handler.class">org.wso2.carbon.apimgt.gateway.handlers.WebsocketHandler</parameter>
      <parameter name="ws.subprotocol.handler.class">org.wso2.carbon.inbound.endpoint.protocol.websocket.subprotocols.EchoSubprotocolHandler</parameter>
      <parameter name="dispatch.custom.sequence">true</parameter>
      <parameter name="ws.outflow.dispatch.fault.sequence">fault</parameter>
      <parameter name="ws.client.side.broadcast.level">0</parameter>



For a list of all default ports opened in WSO2 API Manager, see Default Product Ports.