Contact Free trial Login

Working with Applications

logo cloud active logo hybrid disabled logo server disabled logo pcf disabled

This API deals only with cloud deployments using the cloud-based version of the Runtime Manager. See Deployment Strategies for a better understanding of the different possible deployment scenarios. For managing on-premises applications using an API, see the Runtime Manager API Portal

The application API allows you to list, create, update, and delete applications. All resources or methods that return or accept a type (except where noted) use the application JSON type. As an example, here’s data you might receive, in JSON format, in response to a request to get an application:

  "filename": "",
  "muleVersion", "3.3.0"
  "properties": {
   "secureDataGateway": {
     "connected": false

Application Properties

The following are the properties for applications.

Property Description


The short domain name of the application.


The long domain name of the application.


Whether or not an application file has been supplied for this application.


The Mule version for this application. Either 3.1.2 or 3.2.0.


A set of environment variables that get set when the application is started.


The number of workers associated with this application.


The status of the application. STARTED, DEPLOYING, UNDEPLOYED, DEPLOYED_FAILED are valid values.


Whether or not the data gateway is connected, and how long it’s been connected.

Operations for Applications

The following is a summary of the operations you can perform on your application and the resource you specify for each.

Operation Resource Description



Lists all applications.


Creates an application.



Gets an application.


Deploys a Mule application file.



Updates the metadata for an application.


Deletes an application.

Check out the API Portal of the CloudHub API to see an interactive reference of all the supported resources, methods, required properties and expected responses.

In the API Portal, search among other Mule APIs for the CloudHub API and enter its latest version.

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.