---
schema_version: "1"
id: 2fdc1f4e433859249ea9244c6f708c4e49299ab293873fdbb3a68f07f30c6ef2
title: CLI for CloudHub Applications
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/anypoint-cli/3.x/cloudhub-apps.md
canonical_url: https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 2b876377a34db4d1710535ec0b2cd4b5d8dc3ca5fd7179a42bdd074196188d70
description: MuleSoft Documentation Site
release: 3.x
latest: false
---
---
product: Anypoint CLI
version: 3.x
---

# CLI for CloudHub Applications

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-alert-list">runtime-mgr cloudhub-alert list</a></p></div></div></td><td><div><div><p>Lists all alerts in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-alert-history-describe">runtime-mgr cloudhub-alert-history describe</a></p></div></div></td><td><div><div><p>Describes the history of the alarm</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-list">runtime-mgr cloudhub-application list</a></p></div></div></td><td><div><div><p>Lists all applications in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-describe">runtime-mgr cloudhub-application describe</a></p></div></div></td><td><div><div><p>Show application details</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-describe-json">runtime-mgr cloudhub-application describe-json</a></p></div></div></td><td><div><div><p>Show raw application JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-stop">runtime-mgr cloudhub-application stop</a></p></div></div></td><td><div><div><p>Stop a running application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-start">runtime-mgr cloudhub-application start</a></p></div></div></td><td><div><div><p>Start an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-restart">runtime-mgr cloudhub-application restart</a></p></div></div></td><td><div><div><p>Restart a running application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-delete">runtime-mgr cloudhub-application delete</a></p></div></div></td><td><div><div><p>Delete an application</p></div></div></td></tr><tr><td><div><div><p><a href="#deploy-to-cloudhub">runtime-mgr cloudhub-application deploy</a></p></div></div></td><td><div><div><p>Deploy a new application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-modify">runtime-mgr cloudhub-application modify</a></p></div></div></td><td><div><div><p>Modify an existing application, optionally updating the ZIP file</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-download-logs">runtime-mgr cloudhub-application download-logs</a></p></div></div></td><td><div><div><p>Download application logs to specified directory</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-tail-logs">runtime-mgr cloudhub-application tail-logs</a></p></div></div></td><td><div><div><p>Tail application logs</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cloudhub-application-copy">runtime-mgr cloudhub-application copy</a></p></div></div></td><td><div><div><p>Copies a CloudHub application</p></div></div></td></tr></tbody></table>

## runtime-mgr cloudhub-alert list

\> runtime-mgr cloudhub-alert list \[options\]

This command lists all alerts associated with your current environment.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-alert-history describe

\> runtime-mgr cloudhub-alert-history describe \[options\] <name>

This command describes the history of the alarm passed in `<name>`.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application list

\> runtime-mgr cloudhub-application list \[options\]

This command lists all applications available in your Anypoint Platform CLI. It returns your
application name, its status, the number of vCores assigned and the last time it was updated.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application describe

\> runtime-mgr cloudhub-application describe \[options\] <name>

This command displays information on the application you pass in `<name>`.  
You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass.  
The command returns data such as the application’s domain, its status, the last time it was updated,
the Mule version, the ZIP file name, the region, monitoring, and workers; as well as `TRUE` or
`FALSE` information for persistent queues and static IPs enablement.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application describe-json

\> runtime-mgr cloudhub-application describe-json \[options\] <name>

This command returns the raw JSON response of the application you specify in `<name>`.

You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application stop

\> runtime-mgr cloudhub-application stop \[options\] <name>

This command stops the running application you specify in `<name>`  
You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application start

\> runtime-mgr cloudhub-application start \[options\] <name>

This command starts the running application you specify in `<name>`  
You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application restart

\> runtime-mgr cloudhub-application restart \[options\] <name>

This command restarts the running application you specify in `<name>`  
You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application delete

\> runtime-mgr cloudhub-application delete \[options\] <name>

This command deletes the running application you specify in `<name>`.

> [!WARNING] This command does not prompt twice before deleting. If you send a delete instruction,
> it does not ask for confirmation.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application deploy

\> runtime-mgr cloudhub-application deploy \[options\] <name> <zipfile>

This command deploys the Mule deployable archive ZIP file that you specify in `<zipfile>` using the
name you set in `<name>`.  
You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass.  
You will have to provide the absolute or relative path to the deployable ZIP file in your local hard
drive and the name you give to your application has to be unique.

> [!NOTE] If successful, this command’s output includes the deployment status of `UNDEPLOYED`, which
> indicates that CloudHub uploaded the application successfully.

The options this command can take are:

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>--runtime</p></div></div></td><td><div><div><p>Name and version of the runtime environment.<br>Use this option to specify the name and version of the runtime you want to deploy. If you don’t specify a runtime version, CloudHub API deploys the latest version available considering the values you select for <code>--javaVersion</code> and <code>--releaseChannel</code>.<br>Some examples of this value are <code>2.1.1-API-Gateway</code>, <code>3.9.1-visualizer</code>, <code>4.1.1</code>, <code>4.5</code>, <code>4.6-e-java8</code>, <code>4.6-java8</code>, and <code>4.6-e-java17</code>.<br>Tap your <code>tab</code> key after this option for the CLI to show you all your available options. (This value is the latest CloudHub Runtime version by default.)</p></div></div></td></tr><tr><td><div><div><p>--releaseChannel</p></div></div></td><td><div><div><p>Set the name of the release channel to be used for the selected Mule version. Supported values are <code>NONE</code>, <code>EDGE</code>, and <code>LTS</code>. If you do not specify a value, CloudHub API imposes the default value. The default release channel is <code>EDGE</code>. If you don’t specify a Mule version, the default Mule version for the selected release channel is used. If the selected release channel doesn’t exist, you get an error.</p></div></div></td></tr><tr><td><div><div><p>--javaVersion</p></div></div></td><td><div><div><p>Set the name of the Java version to be used for the selected Mule version. Supported values are <code>8</code> and <code>17</code>. If you do not specify a value, CloudHub API imposes the default value. The default Java version for Mule 4.6 and earlier versions is '8'. If you don’t specify a Mule version, the default Mule version for the selected Java version is used. If the Java version you select is not available for the specified Mule version, you get an error.</p></div></div></td></tr><tr><td><div><div><p>--workers</p></div></div></td><td><div><div><p>Number of workers. (This value is '1' by default)</p></div></div></td></tr><tr><td><div><div><p>--workerSize</p></div></div></td><td><div><div><p>Size of the workers in vCores. (This value is '1' by default)</p></div></div></td></tr><tr><td><div><div><p>--region</p></div></div></td><td><div><div><p>Name of the region to deploy to.<br>For a list of all supported regions, use the <a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-region-list">cloudhub region list</a> command.</p></div></div></td></tr><tr><td><div><div><p>--property</p></div></div></td><td><div><div><p>Set a property (<code>name:value</code>). Can be specified multiple times.<br>The property to be set must be passed enclosed in quotes and characters <code>:</code> and <code>=</code> must be escaped.<br>(e.g. <code>--property "salesforce.password:qa\=34534"</code>).</p></div><div><p>Character <code>:</code> is not supported for the property’s name.</p></div></div></td></tr><tr><td><div><div><p>--propertiesFile</p></div></div></td><td><div><div><p>Overwrite all properties with values from this file. The file format is 1 or more lines in <code>name:value</code> format. Set the absolute path of the properties file in your local hard drive.</p></div></div></td></tr><tr><td><div><div><p>--persistentQueues</p></div></div></td><td><div><div><p>Enable or disable persistent queues. Can take <code>true</code> or <code>false</code> values. (This value is <code>false</code> by default)</p></div></div></td></tr><tr><td><div><div><p>--persistentQueuesEncrypted</p></div></div></td><td><div><div><p>Enable or disable persistent queue encryption. Can take <code>true</code> or <code>false</code> values. (This value is <code>false</code> by default)</p></div></div></td></tr><tr><td><div><div><p>--staticIPsEnabled</p></div></div></td><td><div><div><p>Enable or disable static IPs. Can take <code>true</code> or <code>false</code> values. (This value is <code>false</code> by default)</p></div></div></td></tr><tr><td><div><div><p>--objectStoreV1</p></div></div></td><td><div><div><p>Enable or disable Object Store V1. Can take <code>true</code> or <code>false</code> values.<br><code>objectStoreV2</code> cannot also be provided when using <code>objectStoreV1</code>.</p></div></div></td></tr><tr><td><div><div><p>--objectStoreV2</p></div></div></td><td><div><div><p>Enable or disable Object Store V2. Can take <code>true</code> or <code>false</code> values.<br><code>objectStoreV1</code> cannot also be provided when using <code>objectStoreV2</code>.</p></div></div></td></tr><tr><td><div><div><p>--autoRestart</p></div></div></td><td><div><div><p>Automatically restart app when not responding. Can take <code>true</code> or <code>false</code> values. (This value is <code>true</code> by default.)</p></div></div></td></tr><tr><td><div><div><p>--timeout</p></div></div></td><td><div><div><p>Set the timeout value in miliseconds. Can take values between <code>60000</code> and <code>300000</code>.</p></div></div></td></tr><tr><td><div><div><p>--help</p></div></div></td><td><div><div><p>output usage information</p></div></div></td></tr></tbody></table>

Note that from Anypoint Platform CLI you won’t be able to allocate static IPs. You can simply enable
and disable them.

After typing any option, you can double tap the `tab` key for a full list of all possible options.
For example:

\> deploy <app name> --runtime \[tab\]\[tab\]

Lists all possible runtimes you can select.

> [!IMPORTANT] If you deploy without using any options, your application will deploy using all your
> default values.

## runtime-mgr cloudhub-application modify

\> runtime-mgr cloudhub-application modify \[options\] <name> \[zipfile\]

This command updates the settings of an existing application. Optionally you can update it by
uploading a new ZIP file.  
You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass. This
command can take all the same options as the `deploy` option.

> [!NOTE] This command’s output includes `Status`, which is the application’s previous deployment
> status state.

You can also start typing your option and press `tab` for Anypoint Platform CLI to autocomplete it
for you.

## runtime-mgr cloudhub-application download-logs

\> runtime-mgr cloudhub-application download-logs \[options\] <name> <directory>

This command downloads logs the for application specified in `<name>` to the specified directory.

You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass.

Keep in mind that contrarily to what you see in the UI, the logs you download from the CLI won’t
separate system logs from worker logs.

## runtime-mgr cloudhub-application tail-logs

\> runtime-mgr cloudhub-application tail-logs \[options\] <name>

This command tails application logs.  
You can start typing your application’s name and press `tab` for Anypoint Platform CLI to
autocomplete it, or you can double tap `tab` for a full list of all the values you can pass.

This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## runtime-mgr cloudhub-application copy

\> runtime-mgr cloudhub-application copy \[options\] <source> <target>

This command copies the CloudHub application passed in `source` to the target passed in `target`.

Arguments `source` and `target` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.

If `group_id` is not specified, it defaults to the currently selected Organization ID.

For example:

\> runtime-mgr cloudhub-application copy Services:QA/application-1 Development:QA/application-2

Copies the application named `application-1` from the QA environment of the Services organization to
the QA environment of the Development organization.  
If the Anypoint Platform CLI is using the QA environment in the Services organization, the command
can simply take the application name as a `source`:

\> runtime-mgr cloudhub-application copy application-1 Development/QA/application-2

> [!NOTE] Running this command requires your user to have read/write access to the `/tmp` directory
> of the OS where CLI is installed.

In addition to the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also
takes:

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>--property</p></div></div></td><td><div><div><p>Set a property (<code>name:value</code>). Can be specified multiple times.</p></div><div><p>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters, for example:</p></div><div><p><code>--property "salesforce.password:qa\=34534"</code></p></div></div></td></tr></tbody></table>

> [!NOTE] When copying an application containing safely hidden application properties, pass the
> properties in the `copy` command using the `--property` option. For information about safely
> hidden application properties, see
> [Safely Hide Application Properties](https://docs.mulesoft.com/cloudhub/secure-application-properties).