Contact Free trial Login

Add Servers to Runtime Manager

logo cloud disabled logo hybrid active logo server active logo rtf disabled

To add a Mule server to the Runtime Manager console so that you can manage it, you must first register it with the Runtime Manager agent. Use the amc_setup script to configure the Runtime Manager agent to communicate with Runtime Manager.


  • Your enterprise license is current.

  • You are running Mule 3.6.0 or later, and API gateway 2.1 or later.

  • If you must download the agent, you have an Enterprise support account.

  • If the server is already registered with another Runtime Manager instance, remove that registration first.

Add a Server

To add a Mule server to Runtime Manager:

  1. From Anypoint Platform, select Runtime Manager.

  2. Click Servers in the left menu.

  3. Click the Add Server button.

    Runtime Manager generates the amc_setup command, including token and server-name, for you to use to register Mule in your environment:

    amc_setup command
    Figure 1. The arrow shows the amc_setup command generated by Add Server.

    The registration token includes your organization’s ID and the current environment.

  4. Click Copy to copy the command.

  5. In a terminal window, change to the $MULE_HOME/bin directory for the Mule instance that you’re registering.

  6. Paste the command on the command line.

  7. Change the instance name server-name to the unique name to use to label Mule in the Runtime Manager console.

    Server names can contain up to 60 alphanumeric characters (a-z, A-Z, 0-9), periods (.), hyphens (-) and underscores (_), but not spaces or other special characters. Runtime Manager supports Unicode characters in server names.

    The server-name value is unique across environments. If the same organization exists in different environments, the server-name can be the same in those organizations.

  8. Include any other parameters on the amc_setup command line.

    For information, see amc_setup Parameters.

  9. If your environment requires all outbound calls to go through a proxy, specify proxy settings in either the $MULE_HOME/conf/mule-agent.yml file or the $MULE_HOME/conf/wrapper.conf file.

  10. If you are using the IBM JVM, see IBM JVM.

When the amc_setup command completes successfully, you see:

Mule Agent configured successfully
Connecting to Access Management to extract client_id and client_secret
Credentials extracted correctly, updating wrapper conf file

After the script completes successfully, your server is listed on the Servers tab of Runtime Manager with a status of Created.

If the server was running when you ran the amc_setup script, restart the server to reconnect with Runtime Manager.


When creating a server using the IBM Java Virtual Machine (JVM), you must use a different truststore file than the default truststore installed by the Runtime Manager agent.

  1. Download the custom truststore from this knowledgebase article:

  2. Depending on your Mule version, rename the truststore file in $MULE_HOME/conf to one of these file names:

    • anypoint-truststore.jks

      Mule 4.1.3 (Mule Agent 2.1.4) and later

    • truststore.jks

      Mule 4.1.2 (Mule Agent 2.1.3)

  3. Copy the custom truststore into the $MULE_HOME/conf folder.

  4. Restart Mule.

Remove a Server from Another Runtime Manager Instance

If the server you want to add is already registered with a different instance of Runtime Manager, you must remove it before you can register.

To remove the server from Runtime Manager:

  1. In Runtime Manager, delete the server from the Server tab.

  2. In the $MULE_HOME/conf directory, delete the mule-agent.yaml and mule-agent.jks files.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub