Metamug Console

Metamug Console provides a framework for REST API creation, management and hosting. REST APIs built with the open-source metamug mason are data-driven, designed easily in few clicks through the user-friendly web console interface.

API security and API permissions are handled by the framework in order to guarantee security and privacy of data. The platform also provides automatic generation of API documentation. The framework provides many other features to help developers deliver APIs faster.

Metamug Block Diagram

Metamug Request - Response Flow

Metamug maintains a channel to allow components to communicate with the request and the response. The database access and external API calls are available at every step to allow the components to communicate with the request and database.

The diagram below explains how the request is processed by metamug. The request is available to each process in the chain and each process can alter and relay the request information for it's subsequent process.

Metamug Request-Response

The response for the request is generated as soon as the request is handled and it is carried forward from process to process until the final process is reached. Here the response is serialized and send back to the client.

How to start/stop the server

For Windows

Go the \bin folder and run the following

For starting the server.


For Stopping the server.


For Mac/Linux

Go to the /bin folder and run the following

For starting the server

sh start

For starting the server on the main thread of the terminal, this will show the logs on the terminal screen

sh run 

For stopping the server

sh stop 

Setting min/max heap size for Java runtime

For Windows, Open /bin/setenv.bat and locate the following line in the file

set "JAVA_OPTS=%JAVA_OPTS% -Xms512m -Xmx2048m"

Xms and Xmx represents the minimum and maximum value in mb respectively. You can modify the values according to your requirements

For Max/Linux, Open /bin/ and locate the following lines in the file



Point your browser at http://localhost:7000/ You should see Metamug's Launch Page.

  1. Login into your account using the default credentials given above and voila!! you're ready to use the Metamug Console.
username: admin
password: admin
  1. You'll need internet connection to download updates later. Otherwise you can use console without internet.

  2. PDF Guide is available online at:


A common startup problem is when another program has claimed port 7000, which Metamug is configured to run on by default. To avoid this port conflict, Metamug's port can be changed in conf/server.xml.

If you encounter any problems, please create a support request at:


Ask at Stackoverflow for Metamug: