# mulesoft Anypoint CLI - Full Documentation

<!-- document id=280520988344569344ccb96d7529032815a90727968b4b46e83dee4ed28779c9 url=/mulesoft/current/en-us/anypoint-cli/3.x/index.md -->

---
product: Anypoint CLI
version: 3.x
---

# Anypoint CLI 3.x

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

Anypoint Platform provides a scripting and command-line tool for both Anypoint Platform and Anypoint
Platform Private Cloud Edition (Anypoint Platform PCE). The command-line interface (CLI) supports
both the interactive shell and standard CLI modes and works with:

- [Anypoint Exchange](https://docs.mulesoft.com/exchange/)

- [Anypoint DataGraph](https://docs.mulesoft.com/datagraph/)

- [Access management](https://docs.mulesoft.com/access-management/)

- [Anypoint Runtime Manager](https://docs.mulesoft.com/runtime-manager/)

- [API Governance](https://docs.mulesoft.com/api-governance/)

  Use Runtime Manager to manage Mule applications deployed to CloudHub (hosted by MuleSoft) and
  locally hosted Mule servers.

- [VPCs](https://docs.mulesoft.com/cloudhub/virtual-private-cloud)

- [CloudHub Load Balancers](https://docs.mulesoft.com/cloudhub/cloudhub-dedicated-load-balancer)

- [API Manager 2.x (Crowd Release)](https://docs.mulesoft.com/api-manager/latest/)

- [Design Center](https://docs.mulesoft.com/design-center/)

## Prerequisites

- Download and install NodeJS and npm (node package manager) on your system.

  Minimum versions required are:

- Node.js LTS version 18.0.0 and later

- npm 6.14.8

  See the [NodeJS download page](https://nodejs.org/en/download/).

- Download and install the Git version management on your system.

  See the [Git download site](https://git-scm.com/downloads).

> [!NOTE] Depending on the configuration of your system, you might need to run these commands using
> administrator credentials.

## Installation

```text
$ npm install -g anypoint-cli@latest
```

> [!NOTE] Depending on the configuration of your system, you might need to run these commands using
> administrator credentials.

## Authentication

You can configure Anypoint CLI authentication with username and password, client ID and client
secret, or a bearer token. At least one method is required.

> [!NOTE] As a part of Multi-factor authentication (MFA) enablement for all users, starting October
> 2022, the only way to use Anypoint CLI will be through
> [Connected Apps](https://docs.mulesoft.com/access-management/connected-apps-overview).

### Username and Password

If you don’t log in using single sign-on (SSO), you can use your username and password to log into
the CLI directly.

<table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>username</code></p></div></div></td><td><div><div><p>Your Anypoint Platform username</p></div><div><p>You can also pass this value using the environment variable <code>export ANYPOINT_USERNAME=&lt;name&gt;</code>.</p></div></div></td></tr><tr><td><div><div><p><code>password</code></p></div></div></td><td><div><div><p>Your Anypoint Platform password</p></div><div><p>You can also pass this value using the environment variable <code>export ANYPOINT_PASSWORD=&lt;pwd&gt;</code>.</p></div></div></td></tr></tbody></table>

For information about logging in using SSO, see
[About Identity Management](https://docs.mulesoft.com/access-management/external-identity).

### Client ID and Client Secret

You can configure a Connected App with the `client_credentials` grant type to use with the CLI.

<table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>client_id</code></p></div></div></td><td><div><div><p>The ID of the Connected App</p></div><div><p>You can also pass this value using the environment variable <code>export ANYPOINT_CLIENT_ID=&lt;client_id&gt;</code>.</p></div></div></td></tr><tr><td><div><div><p><code>client_secret</code></p></div></div></td><td><div><div><p>The client secret of the Connected App</p></div><div><p>You can also pass this value using the environment variable <code>export ANYPOINT_CLIENT_SECRET=&lt;client_secret&gt;</code>.</p></div></div></td></tr></tbody></table>

For more information about Connected Apps, see
[Connected Apps](https://docs.mulesoft.com/access-management/connected-apps-overview).

### Bearer Token

If you have already generated a bearer token, you can pass it to the CLI directly. When you provide
a bearer token, the CLI ignores any provided user or client credentials.

<table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>bearer</code></p></div></div></td><td><div><div><p>A bearer token for the Anypoint Platform</p></div><div><p>Your CLI session expires when the bearer token expires.</p></div></div></td></tr></tbody></table>

For information about generating a bearer token, see
[How to generate your Authorization Bearer token for Anypoint Platform](https://help.salesforce.com/s/articleView?id=001115323&type=1).

## Optional Arguments

The Anypoint CLI takes the following optional arguments:

<table><colgroup><col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>organization</code></p></div></div></td><td><div><div><p>Your organization or sub-organization (business group) within Anypoint Platform. You can specify the root organization name or the name of a specific business group.</p></div><div><p>You can also pass this value using the environment variable <code>export ANYPOINT_ORG=&lt;name&gt;</code>.</p></div></div></td></tr><tr><td><div><div><p><code>environment</code></p></div></div></td><td><div><div><p>Your Anypoint Platform environment</p></div><div><p>You can also pass this value using the environment variable <code>export ANYPOINT_ENV=&lt;name&gt;</code>.</p></div></div></td></tr><tr><td><div><div><p><code>host</code></p></div></div></td><td><div><div><p>The host of your Anypoint Platform Installation<br>By default, this value points to <code>anypoint.mulesoft.com</code>.<br></p></div><div><ul><li><p>If you are using Anypoint Platform PCE, pass the address where you are hosting the platform.</p></li><li><p>If you are using Anypoint Platform EU Cloud, pass your EU control plane address.</p></li></ul></div><div><p>You can also pass this value using a dedicated environment variable <code>ANYPOINT_HOST=&lt;name&gt;</code>.</p></div></div></td></tr></tbody></table>

## Usage

Keep the following in mind while using the Anypoint CLI:

1.  Environment variables override credentials file parameters and command-line parameters override
    environment variables.  
    If you don’t pass a command-line parameter, the default profile properties are used.

2.  If not specified, the default environment is production.

3.  Your Anypoint session expires based on the **Default session timeout** configured in your
    Organization settings.

    For information about your Organization settings, see
    [Manage Root Organization Settings](https://docs.mulesoft.com/access-management/managing-business-groups#manage-root-organization-settings).

4.  The Anypoint CLI works with autocomplete.

    You can start typing the name of the command or parameter and press Tab for autocomplete or
    press Tab+Tab for a list of options.

### Credentials File

The recommended way of passing these options to your Anypoint Platform CLI installation is using the
`credentials` file located inside the `~/.anypoint` directory, which is not automatically created
during installation. Follow these steps to create your credentials file:

1.  Create a directory called `.anypoint` in the `~/` directory for Linux and OSx, or
    `C:\Users\USERNAME \` in Windows.

2.  Navigate to your `.anypoint` directory and create a blank file named `credentials` with the
    following structure:

    ```text
    {
     "default": {
      "username": "yourAnypointUserName",
      "password": "yourAnypointPassword",
      "organization": "",
      "environment": "",
      "host": ""
     },
     "otherProfile": {
      "username": "",
      "password": "",
      "organization": "",
      "environment": "",
      "host": ""
     },
     "connAppProfile": {
      "client_id": "",
      "client_secret": "",
      "organization": "",
      "environment": "",
      "host": ""
     }
    }
    ```

    Note that the `default` profile is used unless the `ANYPOINT_PROFILE` environment variable is
    set:

    ```text
    > export ANYPOINT_PROFILE="otherProfile"
    > anypoint-cli
    ```

Then run the `anypoint-cli` command without any options:

```text
> anypoint-cli
```

### Dedicated Environment Variables

If you choose to pass the credentials when running `anypoint-cli`, pass both parameters as
environment variables: `ANYPOINT_USERNAME` and `ANYPOINT_PASSWORD`.

```text
> export ANYPOINT_USERNAME="username"
> export ANYPOINT_PASSWORD="password"
> anypoint-cli
```

### CLI Options

If you pass only your username, the Anypoint CLI prompts for your password.

```text
> anypoint-cli --username="user"
Password: ****
```

### Pass Commands

After setting up a proper way to access Anypoint Platform from the CLI, you can start passing
commands.  
See [Anypoint Platform CLI 3.x List of Commands](https://docs.mulesoft.com/anypoint-cli/3.x/anypoint-platform-cli-commands) for instructions on
how to use them.

### Use Anypoint CLI Through a Network Proxy

To use the Anypoint CLI through a proxy server, configure the `HTTP_PROXY` and `HTTPS_PROXY`
(uppercase) environment variables with the hostname or IP addresses of your proxy servers.

Depending on your operating system, use the following commands:

- Linux, macOS, or Unix

  `$ export HTTP_PROXY=http://_proxy-server_:80`

  or

  `$ export HTTPS_PROXY=https://_proxy-server_:443`

- Windows

  `> set HTTP_PROXY=http://_proxy-server_:80`

  or

  `> set HTTPS_PROXY=https//_proxy-server_:443`

If the proxy server requires authentication, use these commands:

- Linux, macOS, or Unix

  `$ export HTTP_PROXY=http://_username_:_password_@_proxy-server_:80`

  or

  `$ export HTTPS_PROXY=https://_username_:_password_@_proxy-server_:443`

- Windows

  `> set HTTP_PROXY=http://_username_:_password_@_proxy-server_:80`

  or

  `> set HTTPS_PROXY=https://_username_:_password_@_proxy-server_:443`

## Notes

- To improve the Anypoint CLI experience, we gather anonymized usage data. You can opt out by
  setting `collectMetrics` to false in the `credentials` file.

## See Also

- [Anypoint Platform CLI List of Commands](https://docs.mulesoft.com/anypoint-cli/3.x/anypoint-platform-cli-commands)

<!-- document id=96bb4521509762c58137069f809dcc0ef3fb312d651e6ab8c5604e4fd2aea964 url=/mulesoft/current/en-us/anypoint-cli/3.x/anypoint-platform-cli-commands.md -->

---
product: Anypoint CLI
version: 3.x
---

# Anypoint CLI 3.x List of Commands

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

Anypoint Platform CLI provides the ability to manage these features in Anypoint Platform:

- [Anypoint Platform Account](#account)

- [Environments and Business Groups](#env-business-groups)

- [API Governance](#api-governance)

- [API Manager](#api-mgr)

- [Cloudhub 2.0](#cloudhub2-apps)

- [CloudHub Applications](#cloudhub-apps)

- [CloudHub Dedicated Load Balancers](#cloudhub-dlb)

- [CloudHub Anypoint VPCs](#cloudhub-vpc)

- [DataGraph Load Balancers](#datagraph-load-balancers)

- [DataGraph API Source Management](#datagraph-source)

- [Design Center Projects](#design-center)

- [Exchange Assets](#exchange-assets)

- [Hybrid Applications](#standalone-apps)

- [Alerts for Hybrid Applications](#standalone-alerts)

- [Local Servers](#servers)

- [Local Server Groups](#server-groups)

- [Local Cluster Servers](#server-clusters)

- [Runtime Fabric Application Management](#rtf-apps)

- [Runtime Fabric Instances](#rtf-instances)

## Anypoint Platform Account

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/account#account-user-describe">account user describe</a></p></div></div></td><td><div><div><p>Show account details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/account#account-business-group-list">account business-group list</a></p></div></div></td><td><div><div><p>Lists business groups</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/account#account-business-group-describe">account business-group describe</a></p></div></div></td><td><div><div><p>Show details of a business group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/account#account-environment-list">account environment list</a></p></div></div></td><td><div><div><p>Lists environments</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/account#account-environment-create">account environment create</a></p></div></div></td><td><div><div><p>Create new environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/account#account-environment-delete">account environment delete</a></p></div></div></td><td><div><div><p>Delete an environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/account#account-environment-describe">account environment describe</a></p></div></div></td><td><div><div><p>Shows details of an environment</p></div></div></td></tr></tbody></table>

## Environments and Business Groups

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/env-business-groups#use-environment">use environment</a></p></div></div></td><td><div><div><p>Make specified environment active</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/env-business-groups#use-business-group">use business-group</a></p></div></div></td><td><div><div><p>Make specified business-group active</p></div></div></td></tr></tbody></table>

## API Governance

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Command</p></td><td><p>Description</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-api-evaluate">governance api evaluate</a></p></td><td><p>Evaluates filter criteria to determine which rulesets apply to APIs that meet that criteria</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-api-inspect">governance api inspect</a></p></td><td><p>Inspects an API definition and lists its schemas</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-api-validate">governance api validate</a></p></td><td><p>Validates an API definition against a specified governance ruleset</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-document">governance document</a></p></td><td><p>Creates the documentation file for a governance ruleset definition</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-profile-create">governance profile create</a></p></td><td><p>Creates a governance profile</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-profile-delete">governance profile delete</a></p></td><td><p>Deletes a governance profile</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-profile-info">governance profile info</a></p></td><td><p>Lists information for a specific governance profile ID</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-profile-list">governance profile list</a></p></td><td><p>Lists all governance profiles for an organization</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-profile-update">governance profile update</a></p></td><td><p>Updates a governance profile</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-ruleset-clone">governance ruleset clone</a></p></td><td><p>Clones a governance ruleset and applies specified updates to rules</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-ruleset-info">governance ruleset info</a></p></td><td><p>Lists ruleset rules</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-ruleset-init">governance ruleset init</a></p></td><td><p>Initializes a governance ruleset definition based on a data schema</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-governance#governance-ruleset-validate">governance ruleset validate</a></p></td><td><p>Validates a governance ruleset definition’s format</p></td></tr></tbody></table>

## API Manager

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-alert-add">api-mgr alert add</a></p></div></div></td><td><div><div><p>Creates an API instance alert</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-alert-list">api-mgr alert list</a></p></div></div></td><td><div><div><p>Lists alerts for an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-change-specification">api-mgr api change-specification</a></p></div></div></td><td><div><div><p>Changes the asset version for an API instance by choosing a new version from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-classify">api-mgr api classify</a></p></div></div></td><td><div><div><p>Classifies an API instance in a given environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-delete">api-mgr api delete</a></p></div></div></td><td><div><div><p>Deletes an API</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-deploy">api-mgr api deploy</a></p></div></div></td><td><div><div><p>Deploys an API to CloudHub, hybrid server, or Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-deprecate">api-mgr api deprecate</a></p></div></div></td><td><div><div><p>Deprecates an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-describe">api-mgr api describe</a></p></div></div></td><td><div><div><p>Shows details of an API</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-download-proxy">api-mgr api download-proxy</a></p></div></div></td><td><div><div><p>Downloads the API proxy ZIP file to a local directory</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-edit">api-mgr api edit</a></p></div></div></td><td><div><div><p>Edits an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-list">api-mgr api list</a></p></div></div></td><td><div><div><p>Lists all APIs in API Manager 2.x</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-manage">api-mgr api manage</a></p></div></div></td><td><div><div><p>Manages a new API, API version, or new API instance with an asset from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-promote">api-mgr api promote</a></p></div></div></td><td><div><div><p>Promotes an API instance from source environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-redeploy">api-mgr api redeploy</a></p></div></div></td><td><div><div><p>Redeploys an API to CloudHub, Hybrid server, or Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-api-undeprecate">api-mgr api undeprecate</a></p></div></div></td><td><div><div><p>Undeprecates an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-contract-delete">api-mgr contract delete</a></p></div></div></td><td><div><div><p>Deletes a given API contract</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-contract-list">api-mgr contract list</a></p></div></div></td><td><div><div><p>Lists all contracts to a given API instance.</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-policy-apply">api-mgr policy apply</a></p></div></div></td><td><div><div><p>Applies a policy to a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-policy-describe">api-mgr policy describe</a></p></div></div></td><td><div><div><p>Shows the description and available configuration properties of a given policy template</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-policy-disable">api-mgr policy disable</a></p></div></div></td><td><div><div><p>Disables policy from a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-policy-edit">api-mgr policy edit</a></p></div></div></td><td><div><div><p>Edits the policy configuration of a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-policy-enable">api-mgr policy enable</a></p></div></div></td><td><div><div><p>Enables a policy on a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-policy-list">api-mgr policy list</a></p></div></div></td><td><div><div><p>Lists policies</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-policy-remove">api-mgr policy remove</a></p></div></div></td><td><div><div><p>Removes a policy from a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-tier-add">api-mgr tier add</a></p></div></div></td><td><div><div><p>Creates an SLA tier</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-tier-copy">api-mgr tier copy</a></p></div></div></td><td><div><div><p>Copies an SLA tier from source to a target API Instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-tier-delete">api-mgr tier delete</a></p></div></div></td><td><div><div><p>Deletes an SLA tier from an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/api-mgr#api-mgr-tier-list">api-mgr tier list</a></p></div></div></td><td><div><div><p>Lists the SLA tiers of an API instance</p></div></div></td></tr></tbody></table>

## Cloudhub 2.0

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-delete">runtime-mgr application delete</a></p></div></div></td><td><div><div><p>Deletes an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-deploy">runtime-mgr application deploy</a></p></div></div></td><td><div><div><p>Deploys an application to a specified target using an Exchange application and runs the specified runtime version</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-describe">runtime-mgr application describe</a></p></div></div></td><td><div><div><p>Describes an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-describe-json">runtime-mgr application describe-json</a></p></div></div></td><td><div><div><p>Describes an application in raw JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-download-logs">runtime-mgr application download-logs</a></p></div></div></td><td><div><div><p>Downloads logs of an application from a specification to a specified directory</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-list">runtime-mgr application list</a></p></div></div></td><td><div><div><p>Lists all applications in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-modify">runtime-mgr application modify</a></p></div></div></td><td><div><div><p>Modifies a deployed application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-start">runtime-mgr application start</a></p></div></div></td><td><div><div><p>Starts a stopped application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-stop">runtime-mgr application stop</a></p></div></div></td><td><div><div><p>Stops running an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub2-apps#runtime-mgr-application-tail-logs">runtime-mgr application tail-logs</a></p></div></div></td><td><div><div><p>Tails an application’s logs from a specification</p></div></div></td></tr></tbody></table>

## CloudHub Applications

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps#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>

## CloudHub Dedicated Load Balancers

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-list">cloudhub load-balancer list</a></p></div></div></td><td><div><div><p>Lists all load balancers in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-describe">cloudhub load-balancer describe</a></p></div></div></td><td><div><div><p>Show load balancer details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-describe-json">cloudhub load-balancer describe-json</a></p></div></div></td><td><div><div><p>Show load balancer details in raw JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-create">cloudhub load-balancer create</a></p></div></div></td><td><div><div><p>Create a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-start">cloudhub load-balancer start</a></p></div></div></td><td><div><div><p>Starts a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-stop">cloudhub load-balancer stop</a></p></div></div></td><td><div><div><p>Stops a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-delete">cloudhub load-balancer delete</a></p></div></div></td><td><div><div><p>Delete a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-add">cloudhub load-balancer ssl-endpoint add</a></p></div></div></td><td><div><div><p>Add an additional certificate to an existing load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-remove">cloudhub load-balancer ssl-endpoint remove</a></p></div></div></td><td><div><div><p>Remove a certificate from a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-set-default">cloudhub load-balancer ssl-endpoint set-default</a></p></div></div></td><td><div><div><p>Set the default certificate that the load balancer will serve</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-describe">cloudhub load-balancer ssl-endpoint describe</a></p></div></div></td><td><div><div><p>Show the load balancer configuration for a particular certificate</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-whitelist-add">cloudhub load-balancer whitelist add</a></p></div></div></td><td><div><div><p>Add an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-whitelist-remove">cloudhub load-balancer whitelist remove</a></p></div></div></td><td><div><div><p>Remove an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-mappings-describe">cloudhub load-balancer mappings describe</a></p></div></div></td><td><div><div><p>Lists the proxy mapping rules for a load balancer. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-mappings-add">cloudhub load-balancer mappings add</a></p></div></div></td><td><div><div><p>Add a proxy mapping rule at the specified index. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-mappings-remove">cloudhub load-balancer mappings remove</a></p></div></div></td><td><div><div><p>Remove a proxy mapping rule. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown.</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-dynamic-ips-enable">cloudhub load-balancer dynamic-ips enable</a></p></div></div></td><td><div><div><p>Enables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-load-balancer-dynamic-ips-disable">cloudhub load-balancer dynamic-ips disable</a></p></div></div></td><td><div><div><p>Disables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-region-list">cloudhub region list</a></p></div></div></td><td><div><div><p>Lists all supported regions</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb#cloudhub-runtime-list">cloudhub runtime list</a></p></div></div></td><td><div><div><p>Lists all available runtimes</p></div></div></td></tr></tbody></table>

## CloudHub Anypoint VPCs

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-list">cloudhub vpc list</a></p></div></div></td><td><div><div><p>Lists all Anypoint VPCs</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-describe">cloudhub vpc describe</a></p></div></div></td><td><div><div><p>Show Anypoint VPC details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-describe-json">cloudhub vpc describe-json</a></p></div></div></td><td><div><div><p>Show raw Anypoint VPC JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-create">cloudhub vpc create</a></p></div></div></td><td><div><div><p>Create a new Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-delete">cloudhub vpc delete</a></p></div></div></td><td><div><div><p>Delete an existing Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-environments-add">cloudhub vpc environments add</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments.</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-environments-remove">cloudhub vpc environments remove</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments.</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-business-groups-add">cloudhub vpc business-groups add</a></p></div></div></td><td><div><div><p>Share an Anypoint VPC with a list of Business Groups.</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-business-groups-remove">cloudhub vpc business-groups remove</a></p></div></div></td><td><div><div><p>Share an Anypoint VPC with a list of Business Groups.</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-dns-servers-set">cloudhub vpc dns-servers set</a></p></div></div></td><td><div><div><p>Sets the domain names that are resolved using your internal DNS servers. If used with no option, internal DNS will be disabled</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-dns-servers-unset">cloudhub vpc dns-servers unset</a></p></div></div></td><td><div><div><p>Clears the list domain names that are resolved using your internal DNS servers</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-firewall-rules-describe">cloudhub vpc firewall-rules describe</a></p></div></div></td><td><div><div><p>Show firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-firewall-rules-add">cloudhub vpc firewall-rules add</a></p></div></div></td><td><div><div><p>Add a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc#cloudhub-vpc-firewall-rules-remove">cloudhub vpc firewall-rules remove</a></p></div></div></td><td><div><div><p>Remove a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr></tbody></table>

## DataGraph Load Balancers

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph#datagraph-load-balancer-config-add">datagraph load-balancer-config add</a></p></div></div></td><td><div><div><p>Adds a dedicated load balancer configuration to Anypoint DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph#datagraph-load-balancer-config-describe">datagraph load-balancer-config describe</a></p></div></div></td><td><div><div><p>Displays a dedicated load balancer configuration for Anypoint DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph#datagraph-load-balancer-config-remove">datagraph load-balancer-config remove</a></p></div></div></td><td><div><div><p>Removes a dedicated load balancer configuration from Anypoint DataGraph</p></div></div></td></tr></tbody></table>

## DataGraph API Source Management

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-sources-add">datagraph sources add</a></p></div></div></td><td><div><div><p>Adds an API source</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-sources-promote">datagraph sources promote</a></p></div></div></td><td><div><div><p>Promotes an API source</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-sources-update">datagraph sources update</a></p></div></div></td><td><div><div><p>Updates an API source</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-scale">datagraph scale</a></p></div></div></td><td><div><div><p>Scales API calls made to the unified schema</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-schema-download">datagraph schema-download</a></p></div></div></td><td><div><div><p>Downloads the unified schema</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-sources-delete">datagraph sources delete</a></p></div></div></td><td><div><div><p>Deletes an API source</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-sources-get">datagraph sources get</a></p></div></div></td><td><div><div><p>Gets an API source</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-sources-list">datagraph sources list</a></p></div></div></td><td><div><div><p>Lists all API sources</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source#datagraph-describe">datagraph describe</a></p></div></div></td><td><div><div><p>Returns information about DataGraph</p></div></div></td></tr></tbody></table>

## Design Center Projects

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/design-center#designcenter-project-create">designcenter project create</a></p></div></div></td><td><div><div><p>Creates a new Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/design-center#designcenter-project-delete">designcenter project delete</a></p></div></div></td><td><div><div><p>Deletes a Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/design-center#designcenter-project-download">designcenter project download</a></p></div></div></td><td><div><div><p>Downloads the content of a Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/design-center#designcenter-project-publish">designcenter project publish</a></p></div></div></td><td><div><div><p>Publishes a Design Center project to Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/design-center#designcenter-project-upload">designcenter project upload</a></p></div></div></td><td><div><div><p>Uploads the content of a project to Design Center</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/design-center#designcenter-project-list">designcenter project list</a></p></div></div></td><td><div><div><p>List all Design Center projects</p></div></div></td></tr></tbody></table>

## Exchange Assets

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-upload">exchange asset upload</a></p></div></div></td><td><div><div><p>Uploads an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-uploadv2">exchange asset uploadv2</a></p></div></div></td><td><div><div><p>Uploads an Exchange asset using Exchange Experience API v2</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-mutabledataupload">exchange asset mutableDataUpload</a></p></div></div></td><td><div><div><p>Modifies mutable data of an existing Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-modify">exchange asset modify</a></p></div></div></td><td><div><div><p>Modifies an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-download">exchange asset download</a></p></div></div></td><td><div><div><p>Downloads an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-list">exchange asset list</a></p></div></div></td><td><div><div><p>Lists all assets</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-page-download">exchange asset page download</a></p></div></div></td><td><div><div><p>Downloads an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-page-modify">exchange asset page modify</a></p></div></div></td><td><div><div><p>Changes an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-page-upload">exchange asset page upload</a></p></div></div></td><td><div><div><p>Uploads an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-page-update">exchange asset page update</a></p></div></div></td><td><div><div><p>Updates an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-page-delete">exchange asset page delete</a></p></div></div></td><td><div><div><p>Deletes an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-page-list">exchange asset page list</a></p></div></div></td><td><div><div><p>List all pages for a given asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-copy">exchange asset copy</a></p></div></div></td><td><div><div><p>Copies an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-delete">exchange asset delete</a></p></div></div></td><td><div><div><p>Deletes an asset from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-deprecate">exchange asset deprecate</a></p></div></div></td><td><div><div><p>Deprecates an asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-undeprecate">exchange asset undeprecate</a></p></div></div></td><td><div><div><p>Undeprecate an asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-describe">exchange asset describe</a></p></div></div></td><td><div><div><p>Show a given asset’s information</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-resource-upload">exchange asset resource upload</a></p></div></div></td><td><div><div><p>Uploads a resource to an asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-resource-list">exchange asset resource list</a></p></div></div></td><td><div><div><p>Lists published resources in the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-resource-download">exchange asset resource download</a></p></div></div></td><td><div><div><p>Downloads resource from the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/exchange-assets#exchange-asset-resource-delete">exchange asset resource delete</a></p></div></div></td><td><div><div><p>Deletes resource from the asset portal</p></div></div></td></tr></tbody></table>

## Hybrid Applications

> [!CAUTION] In order for the Anypoint Platform CLI to recognize your target servers, each server
> needs to be manually registered with the platform.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-artifact">runtime-mgr standalone-application artifact</a></p></div></div></td><td><div><div><p>Downloads a standalone application artifact binary</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-deploy">runtime-mgr standalone-application deploy</a></p></div></div></td><td><div><div><p>Deploys or redeploys an application to an on-premises server, server group, or cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-describe-json">runtime-mgr standalone-application describe-json</a></p></div></div></td><td><div><div><p>Shows a raw standalone application JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-modify">runtime-mgr standalone-application modify</a></p></div></div></td><td><div><div><p>Changes a standalone application artifact</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-start">runtime-mgr standalone-application start</a></p></div></div></td><td><div><div><p>Starts a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-delete">runtime-mgr standalone-application delete</a></p></div></div></td><td><div><div><p>Deletes a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-describe">runtime-mgr standalone-application describe</a></p></div></div></td><td><div><div><p>Shows detailed information for a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-list">runtime-mgr standalone-application list</a></p></div></div></td><td><div><div><p>Lists all standalone applications in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-restart">runtime-mgr standalone-application restart</a></p></div></div></td><td><div><div><p>Restarts a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-stop">runtime-mgr standalone-application stop</a></p></div></div></td><td><div><div><p>Stops a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps#runtime-mgr-standalone-application-copy">runtime-mgr standalone-application copy</a></p></div></div></td><td><div><div><p>Copies a standalone application</p></div></div></td></tr></tbody></table>

## Alerts for Hybrid Applications

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-alerts#runtime-mgr-standalone-alert-describe">runtime-mgr standalone-alert describe</a></p></div></div></td><td><div><div><p>Describes an alert</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-alerts#runtime-mgr-standalone-alert-create">runtime-mgr standalone-alert create</a></p></div></div></td><td><div><div><p>Creates new alert for standalone runtime</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-alerts#runtime-mgr-standalone-alert-modify">runtime-mgr standalone-alert modify</a></p></div></div></td><td><div><div><p>Modifies alert for standalone runtime</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/standalone-alerts#runtime-mgr-standalone-alert-list">runtime-mgr standalone-alert list</a></p></div></div></td><td><div><div><p>Lists all alerts for standalone runtimes in the environment</p></div></div></td></tr></tbody></table>

## Local Servers

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/servers#runtime-mgr-server-describe">runtime-mgr server describe</a></p></div></div></td><td><div><div><p>Describes server</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/servers#runtime-mgr-server-modify">runtime-mgr server modify</a></p></div></div></td><td><div><div><p>Modifies server</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/servers#runtime-mgr-server-token">runtime-mgr server token</a></p></div></div></td><td><div><div><p>Gets server registration token. This token needs to be used to register a new server</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/servers#runtime-mgr-server-delete">runtime-mgr server delete</a></p></div></div></td><td><div><div><p>Deletes server</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/servers#runtime-mgr-server-list">runtime-mgr server list</a></p></div></div></td><td><div><div><p>Changes an standalone application artifact</p></div></div></td></tr></tbody></table>

## Local Server Groups

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-groups#runtime-mgr-servergroup-create">runtime-mgr serverGroup create</a></p></div></div></td><td><div><div><p>Creates server group from servers</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-groups#runtime-mgr-servergroup-describe">runtime-mgr serverGroup describe</a></p></div></div></td><td><div><div><p>Describes server group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-groups#runtime-mgr-servergroup-modify">runtime-mgr serverGroup modify</a></p></div></div></td><td><div><div><p>Modifies server group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-groups#runtime-mgr-servergroup-add-server">runtime-mgr serverGroup add server</a></p></div></div></td><td><div><div><p>Adds server to a server group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-groups#runtime-mgr-servergroup-delete">runtime-mgr serverGroup delete</a></p></div></div></td><td><div><div><p>Deletes server group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-groups#runtime-mgr-servergroup-list">runtime-mgr serverGroup list</a></p></div></div></td><td><div><div><p>Lists all server groups in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-groups#runtime-mgr-servergroup-remove-server">runtime-mgr serverGroup remove server</a></p></div></div></td><td><div><div><p>Removes server from a server group</p></div></div></td></tr></tbody></table>

## Local Cluster Servers

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters#runtime-mgr-cluster-add-server">runtime-mgr cluster add server</a></p></div></div></td><td><div><div><p>Adds server to cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters#runtime-mgr-cluster-delete">runtime-mgr cluster delete</a></p></div></div></td><td><div><div><p>Deletes cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters#runtime-mgr-cluster-list">runtime-mgr cluster list</a></p></div></div></td><td><div><div><p>Lists all clusters in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters#runtime-mgr-cluster-remove-server">runtime-mgr cluster remove server</a></p></div></div></td><td><div><div><p>Removes server from a cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters#runtime-mgr-cluster-create">runtime-mgr cluster create</a></p></div></div></td><td><div><div><p>Creates new cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters#runtime-mgr-cluster-describe">runtime-mgr cluster describe</a></p></div></div></td><td><div><div><p>Describes server cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters#runtime-mgr-cluster-modify">runtime-mgr cluster modify</a></p></div></div></td><td><div><div><p>Modifies cluster</p></div></div></td></tr></tbody></table>

## Runtime Fabric Application Management

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-delete">runtime-mgr application delete</a></p></div></div></td><td><div><div><p>Deletes an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-deploy">runtime-mgr application deploy</a></p></div></div></td><td><div><div><p>Deploys an application to a specified target using an Exchange application and runs the specified runtime version</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-describe">runtime-mgr application describe</a></p></div></div></td><td><div><div><p>Describes an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-describe-json">runtime-mgr application describe-json</a></p></div></div></td><td><div><div><p>Describes an application in a raw JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-download-logs">runtime-mgr application download-logs</a></p></div></div></td><td><div><div><p>Downloads logs of an application from a specification to a specified directory</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-list">runtime-mgr application list</a></p></div></div></td><td><div><div><p>Lists all applications in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-modify">runtime-mgr application modify</a></p></div></div></td><td><div><div><p>Modifies a deployed application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-start">runtime-mgr application start</a></p></div></div></td><td><div><div><p>Starts a stopped application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-stop">runtime-mgr application stop</a></p></div></div></td><td><div><div><p>Stops running an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps#runtime-mgr-application-tail-logs">runtime-mgr application tail-logs</a></p></div></div></td><td><div><div><p>Tails an application’s logs from a specification</p></div></div></td></tr></tbody></table>

## Runtime Fabric Instances

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/3.x/rtf-instances#runtime-mgr-rtf-list">runtime-mgr rtf list</a></p></div></div></td><td><div><div><p>Lists available Runtime Fabric instances</p></div></div></td></tr></tbody></table>

<!-- document id=25521c290291141e6f3f926be7c7a27ea1da472d94d63540b37d2a4e449d6483 url=/mulesoft/current/en-us/anypoint-cli/latest/anypoint-platform-cli-commands.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Anypoint CLI 4.x List of Commands

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

Anypoint Platform CLI provides the ability to manage these features in Anypoint Platform:

- [Anypoint Platform Accounts](#account)

- [Agent Fabric](#agent-fabric)

- [API Catalog](#catalog)

- [API Governance](#api-gov)

- [API Manager](#api-mgr)

- [Cloudhub 2.0](#cloudhub-2)

- [Cloudhub Apps](#cloudhub-apps)

- [Cloudhub Dedicated Load Balancers](#cloudhub-dlb)

- [Cloudhub Anypoint VPCs](#cloudhub-vpc)

- [Datagraph Load Balancer](#datagraph-load-balancer)

- [Design Center](#design-center)

- [DX Mule](#dx-mule)

- [Exchange Assets](#exchange)

- [Hybrid Applications](#standalone-apps)

- [Alerts for Hybrid Applications](#standalone-alerts)

- [Local Servers](#servers)

- [Local Server Clusters](#server-clusters)

- [Local Server Groups](#server-groups)

- [Managed Omni Gateways](#managed-gateways)

- [PDK Policy Projects](#policy-project)

## Anypoint Platform Accounts

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/account#account-business-group-describe">account:business-group:describe</a></p></div></div></td><td><div><div><p>Show details of a business group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/account#account-business-group-list">account:business-group:list</a></p></div></div></td><td><div><div><p>Lists business groups</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/account#account-environment-create">account:environment:create</a></p></div></div></td><td><div><div><p>Create new environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/account#account-environment-delete">account:environment:delete</a></p></div></div></td><td><div><div><p>Delete an environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/account#account-environment-describe">account:environment:describe</a></p></div></div></td><td><div><div><p>Shows details of an environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/account#account-environment-list">account:environment:list</a></p></div></div></td><td><div><div><p>Lists environments</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/account#account-user-describe">account:user:describe</a></p></div></div></td><td><div><div><p>Show account details</p></div></div></td></tr></tbody></table>

## Agent Fabric

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/agent-fabric#agent-network-project-build">agent-network:project:build</a></p></div></div></td><td><div><div><p>Builds the agent network project and validates configuration</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/agent-fabric#agent-network-project-create">agent-network:project:create</a></p></div></div></td><td><div><div><p>Creates a new agent network project and generates the initial configuration files</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/agent-fabric#agent-network-project-deploy">agent-network:project:deploy</a></p></div></div></td><td><div><div><p>Deploys the agent network project to the target environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/agent-fabric#agent-network-project-publish">agent-network:project:publish</a></p></div></div></td><td><div><div><p>Publishes the agent network project to Anypoint Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/agent-fabric#agent-network-project-undeploy">agent-network:project:undeploy</a></p></div></div></td><td><div><div><p>Undeploys the agent network project and removes all deployed runtime resources</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/agent-fabric#agent-network-project-unpublish">agent-network:project:unpublish</a></p></div></div></td><td><div><div><p>Unpublishes the agent network project asset versions from Anypoint Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/agent-fabric#agent-network-setup-gateways">agent-network:setup:gateways</a></p></div></div></td><td><div><div><p>Sets up the gateways for the agent network</p></div></div></td></tr></tbody></table>

## API Catalog

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-catalog#autocomplete-command">api-catalog autocomplete</a></p></div></div></td><td><div><div><p>Configures autocompletion for API Catalog commands</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-catalog#conf-command">api-catalog conf</a></p></div></div></td><td><div><div><p>Creates or deletes a credentials configuration file</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-catalog#create-descriptor-command">api-catalog create-descriptor</a></p></div></div></td><td><div><div><p>Creates a descriptor file</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-catalog#update-descriptor-command">api-catalog update-descriptor</a></p></div></div></td><td><div><div><p>Updates a descriptor file</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-catalog#publish-asset-command">api-catalog publish-asset</a></p></div></div></td><td><div><div><p>Publishes assets to Exchange</p></div></div></td></tr></tbody></table>

## API Governance

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Command</p></td><td><p>Description</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-api-evaluate">governance:api:evaluate</a></p></td><td><p>Evaluates filter criteria to determine which rulesets apply to APIs that meet that criteria</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-api-inspect">governance:api:inspect</a></p></td><td><p>Inspects an API specification and lists its schemas</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-api-validate">governance:api:validate</a></p></td><td><p>Validates an API specification against a specified governance ruleset</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-document">governance:document</a></p></td><td><p>Creates the documentation file for a governance ruleset definition</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-profile-create">governance:profile:create</a></p></td><td><p>Creates an active governance profile</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-profile-delete">governance:profile:delete</a></p></td><td><p>Deletes a governance profile</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-profile-info">governance:profile:info</a></p></td><td><p>Lists information for a specific governance profile ID</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-profile-list">governance:profile:list</a></p></td><td><p>Lists all governance profiles for an organization</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-profile-update">governance:profile:update</a></p></td><td><p>Updates a governance profile</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-clone">governance:ruleset:clone</a></p></td><td><p>Clones a governance ruleset and applies specified updates to rules</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-classes">governance:ruleset:classes</a></p></td><td><p>Lists the target classes available for governance rulesets, grouped by prefix</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-completions">governance:ruleset:completions</a></p></td><td><p>Returns context-aware completions at a cursor position in a ruleset YAML file</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-constraints">governance:ruleset:constraints</a></p></td><td><p>Lists valid constraints by property type</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-domains">governance:ruleset:domains</a></p></td><td><p>Lists available metadata domains for governance rulesets</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-generate">governance:ruleset:generate</a></p></td><td><p>Returns context and instructions for generating a ruleset from a natural-language description</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-info">governance:ruleset:info</a></p></td><td><p>Lists ruleset rules</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-init">governance:ruleset:init</a></p></td><td><p>Initializes a governance ruleset definition based on a data schema</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-properties">governance:ruleset:properties</a></p></td><td><p>Lists the properties and types for a target class</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-resolve">governance:ruleset:resolve</a></p></td><td><p>Resolves a user-facing term to its canonical target class and property path</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-simplify">governance:ruleset:simplify</a></p></td><td><p>Simplifies a ruleset by flattening nested paths and removing redundant logical wrappers</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-validate">governance:ruleset:validate</a></p></td><td><p>Validates a governance ruleset definition’s format</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-validate-authoring">governance:ruleset:validate-authoring</a></p></td><td><p>Validates a ruleset against the authoring model</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-governance#governance-ruleset-version">governance:ruleset:version</a></p></td><td><p>Shows the governance ruleset tooling version</p></td></tr></tbody></table>

## API Manager

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-alert-add">api-mgr:alert:add</a></p></div></div></td><td><div><div><p>Creates an API instance alert</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-alert-list">api-mgr:alert:list</a></p></div></div></td><td><div><div><p>Lists alerts for an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-autodiscovery">api-mgr:api:autodiscovery</a></p></div></div></td><td><div><div><p>Lists the autodiscovery properties</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-change-specification">api-mgr:api:change-specification</a></p></div></div></td><td><div><div><p>Changes the asset version for an API instance by choosing a new version from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-classify">api-mgr:api:classify</a></p></div></div></td><td><div><div><p>Classifies an API instance in a given environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-delete">api-mgr:api:delete</a></p></div></div></td><td><div><div><p>Deletes an API</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-deploy">api-mgr:api:deploy</a></p></div></div></td><td><div><div><p>Deploys an API to CloudHub, CloudHub2, Hybrid Server, or Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-deprecate">api-mgr:api:deprecate</a></p></div></div></td><td><div><div><p>Deprecates an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-describe">api-mgr:api:describe</a></p></div></div></td><td><div><div><p>Shows details of an API</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-download-proxy">api-mgr:api:download-proxy</a></p></div></div></td><td><div><div><p>Downloads the API proxy ZIP file to a local directory</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-edit">api-mgr:api:edit</a></p></div></div></td><td><div><div><p>Edits an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-list">api-mgr:api:list</a></p></div></div></td><td><div><div><p>Lists all APIs in API Manager 2.x</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-manage">api-mgr:api:manage</a></p></div></div></td><td><div><div><p>Manages a new API, API version, or new API instance with an asset from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-promote">api-mgr:api:promote</a></p></div></div></td><td><div><div><p>Promotes an API instance from source environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-redeploy">api-mgr:api:redeploy</a></p></div></div></td><td><div><div><p>Redeploys an API to CloudHub, CloudHub2, Hybrid Server, or Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-api-undeprecate">api-mgr:api:undeprecate</a></p></div></div></td><td><div><div><p>Undeprecates an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-application-add-owner">api-mgr:application:add-owner</a></p></div></div></td><td><div><div><p>Adds an owner to a client application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-application-import">api-mgr:application:import</a></p></div></div></td><td><div><div><p>Imports a client application from an external client identity provider</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-application-possible-owners-list">api-mgr:application:possible-owners-list</a></p></div></div></td><td><div><div><p>Lists possible owners for a client application in the current organization</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-client-provider-list-importable">api-mgr:client-provider:list-importable</a></p></div></div></td><td><div><div><p>Lists client identity providers with import enabled in the current organization</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-contract-delete">api-mgr:contract:delete</a></p></div></div></td><td><div><div><p>Deletes a given API contract</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-contract-list">api-mgr:contract:list</a></p></div></div></td><td><div><div><p>Lists all contracts to a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-policy-apply">api-mgr:policy:apply</a></p></div></div></td><td><div><div><p>Applies a policy to a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-policy-describe">api-mgr:policy:describe</a></p></div></div></td><td><div><div><p>Shows the description and available configuration properties of a given policy template</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-policy-disable">api-mgr:policy:disable</a></p></div></div></td><td><div><div><p>Disables policy from a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-policy-edit">api-mgr:policy:edit</a></p></div></div></td><td><div><div><p>Edits the policy configuration of a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-policy-enable">api-mgr:policy:enable</a></p></div></div></td><td><div><div><p>Enables a policy on a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-policy-list">api-mgr:policy:list</a></p></div></div></td><td><div><div><p>Lists policies</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-policy-remove">api-mgr:policy:remove</a></p></div></div></td><td><div><div><p>Removes a policy from a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-tier-add">api-mgr:tier:add</a></p></div></div></td><td><div><div><p>Creates an SLA tier</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-tier-copy">api-mgr:tier:copy</a></p></div></div></td><td><div><div><p>Copies an SLA tier from source to a target API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-tier-delete">api-mgr:tier:delete</a></p></div></div></td><td><div><div><p>Deletes an SLA tier from an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-tier-list">api-mgr:tier:list</a></p></div></div></td><td><div><div><p>Lists the SLA tiers of an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-upstream-add">api-mgr:upstream:add</a></p></div></div></td><td><div><div><p>Creates an upstream for an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-upstream-bulk-edit">api-mgr:upstream:bulk-edit</a></p></div></div></td><td><div><div><p>Bulk edits the TLS context for all upstreams of an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-upstream-delete">api-mgr:upstream:delete</a></p></div></div></td><td><div><div><p>Deletes an upstream from an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-upstream-edit">api-mgr:upstream:edit</a></p></div></div></td><td><div><div><p>Edits an upstream of an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/api-mgr#api-mgr-upstream-list">api-mgr:upstream:list</a></p></div></div></td><td><div><div><p>Lists all upstreams for an API instance</p></div></div></td></tr></tbody></table>

## Cloudhub 2.0

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-delete">runtime-mgr:application:delete</a></p></div></div></td><td><div><div><p>Deletes an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-describe">runtime-mgr:application:describe</a></p></div></div></td><td><div><div><p>Describes an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-deploy">runtime-mgr:application:deploy</a></p></div></div></td><td><div><div><p>Deploys an application to a specified target using an Exchange application and runs the specified runtime version</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-download-logs">runtime-mgr:application:download:logs</a></p></div></div></td><td><div><div><p>Downloads logs of an application from a specification to a specified directory</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-list">runtime-mgr:application:list</a></p></div></div></td><td><div><div><p>Lists all applications in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-modify">runtime-mgr:application:modify</a></p></div></div></td><td><div><div><p>Modifies a deployed application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-start">runtime-mgr:application:start</a></p></div></div></td><td><div><div><p>Starts a stopped application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-stop">runtime-mgr:application:stop</a></p></div></div></td><td><div><div><p>Stops running an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub2-apps#runtime-mgr-application-logs">runtime-mgr:application:logs</a></p></div></div></td><td><div><div><p>Tails an application’s logs from a specification</p></div></div></td></tr></tbody></table>

## Cloudhub Apps

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#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><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-delete">runtime-mgr:cloudhub:application:delete</a></p></div></div></td><td><div><div><p>Deletes an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#deploy-to-cloudhub">runtime-mgr:cloudhub-application:deploy</a></p></div></div></td><td><div><div><p>Deploys a new application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-describe">runtime-mgr:cloudhub-application:describe</a></p></div></div></td><td><div><div><p>Shows application details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-modify">runtime-mgr:cloudhub-application:modify</a></p></div></div></td><td><div><div><p>Modifies an existing application, optionally updating the ZIP file</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-restart">runtime-mgr:cloudhub-application:restart</a></p></div></div></td><td><div><div><p>Restarts a running application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-start">runtime-mgr:cloudhub-application:start</a></p></div></div></td><td><div><div><p>Starts an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-stop">runtime-mgr:cloudhub-application:stop</a></p></div></div></td><td><div><div><p>Stops a running application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#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="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#cloudhub-region-list">cloudhub:region:list</a></p></div></div></td><td><div><div><p>Lists all supported regions</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#cloudhub-runtime-list">cloudhub:runtime:list</a></p></div></div></td><td><div><div><p>Lists all available runtimes</p></div></div></td></tr></tbody></table>

## Cloudhub Dedicated Load Balancers

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-allowlist-add">cloudhub:load-balancer:allowlist:add</a></p></div></div></td><td><div><div><p>Adds an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-allowlist-remove">cloudhub:load-balancer:allowlist:remove</a></p></div></div></td><td><div><div><p>Removes an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-create">cloudhub:load-balancer:create</a></p></div></div></td><td><div><div><p>Creates a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-delete">cloudhub:load-balancer:delete</a></p></div></div></td><td><div><div><p>Deletes a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-describe">cloudhub:load-balancer:describe</a></p></div></div></td><td><div><div><p>Shows load balancer details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-dynamic-ips-disable">cloudhub:load-balancer:dynamic-ips:disable</a></p></div></div></td><td><div><div><p>Disables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-dynamic-ips-enable">cloudhub:load-balancer:dynamic-ips:enable</a></p></div></div></td><td><div><div><p>Enables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-list">cloudhub:load-balancer:list</a></p></div></div></td><td><div><div><p>Lists all load balancers in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-mappings-add">cloudhub:load-balancer:mappings:add</a></p></div></div></td><td><div><div><p>Adds a proxy mapping rule at the specified index</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-mappings-describe">cloudhub:load-balancer:mappings:describe</a></p></div></div></td><td><div><div><p>Lists the proxy mapping rules for a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-mappings-remove">cloudhub:load-balancer:mappings:remove</a></p></div></div></td><td><div><div><p>Removes a proxy mapping rule</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-add">cloudhub:load-balancer:ssl-endpoint:add</a></p></div></div></td><td><div><div><p>Adds an additional certificate to an existing load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-describe">cloudhub:load-balancer:ssl-endpoint:describe</a></p></div></div></td><td><div><div><p>Shows the load balancer configuration for a particular certificate</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-remove">cloudhub:load-balancer:ssl-endpoint:remove</a></p></div></div></td><td><div><div><p>Removes a certificate from a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-set-default">cloudhub:load-balancer:ssl-endpoint:set-default</a></p></div></div></td><td><div><div><p>Sets the default certificate that the load balancer will serve</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-start">cloudhub:load-balancer:start</a></p></div></div></td><td><div><div><p>Starts a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-stop">cloudhub:load-balancer:stop</a></p></div></div></td><td><div><div><p>Stops a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-whitelist-add">cloudhub:load-balancer:whitelist:add</a></p></div></div></td><td><div><div><p>Adds an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-whitelist-remove">cloudhub:load-balancer:whitelist:remove</a></p></div></div></td><td><div><div><p>Removes an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr></tbody></table>

## Cloudhub Anypoint VPCs

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-business-groups-add">cloudhub:vpc:business-groups:add</a></p></div></div></td><td><div><div><p>Shares an Anypoint VPC with a list of Business Groups</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-business-groups-remove">cloudhub:vpc:business-groups:remove</a></p></div></div></td><td><div><div><p>Shares an Anypoint VPC with a list of Business Groups</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-create">cloudhub:vpc:create</a></p></div></div></td><td><div><div><p>Creates a new Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-delete">cloudhub:vpc:delete</a></p></div></div></td><td><div><div><p>Deletes an existing Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-describe">cloudhub:vpc:describe</a></p></div></div></td><td><div><div><p>Show Anypoint VPC details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-dns-servers-set">cloudhub:vpc:dns-servers:set</a></p></div></div></td><td><div><div><p>Sets the domain names that are resolved using your internal DNS servers</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-dns-servers-unset">cloudhub:vpc:dns-servers:unset</a></p></div></div></td><td><div><div><p>Clears the list domain names that are resolved using your internal DNS servers</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-environments-add">cloudhub:vpc:environments:add</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-environments-remove">cloudhub:vpc:environments:remove</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-firewall-rules-add">cloudhub:vpc:firewall-rules:add</a></p></div></div></td><td><div><div><p>Adds a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-firewall-rules-describe">cloudhub:vpc:firewall-rules:describe</a></p></div></div></td><td><div><div><p>Shows firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-firewall-rules-remove">cloudhub:vpc:firewall-rules:remove</a></p></div></div></td><td><div><div><p>Removes a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-list">cloudhub:vpc:list</a></p></div></div></td><td><div><div><p>Lists all Anypoint VPCs</p></div></div></td></tr></tbody></table>

## Datagraph Load Balancer

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/datagraph-load-balancer#datagraph-load-balancer-config-add">datagraph:load-balancer-config:add</a></p></div></div></td><td><div><div><p>Adds a dedicated load balancer configuration to Anypoint DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/datagraph-load-balancer#datagraph-load-balancer-config-describe">datagraph:load-balancer-config:describe</a></p></div></div></td><td><div><div><p>Displays a dedicated load balancer configuration for Anypoint DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/datagraph-load-balancer#datagraph-load-balancer-config-remove">datagraph:load-balancer-config:remove</a></p></div></div></td><td><div><div><p>Removes a dedicated load balancer configuration from Anypoint DataGraph</p></div></div></td></tr></tbody></table>

## Design Center

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/design-center#designcenter-project-create">designcenter:project:create</a></p></div></div></td><td><div><div><p>Creates a new Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/design-center#designcenter-project-delete">designcenter:project:delete</a></p></div></div></td><td><div><div><p>Deletes a Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/design-center#designcenter-project-download">designcenter:project:download</a></p></div></div></td><td><div><div><p>Downloads the content of a Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/design-center#designcenter-project-list">designcenter:project:list</a></p></div></div></td><td><div><div><p>Lists all Design Center projects</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/design-center#designcenter-project-publish">designcenter:project:publish</a></p></div></div></td><td><div><div><p>Publishes a Design Center project to Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/design-center#designcenter-project-upload">designcenter:project:upload</a></p></div></div></td><td><div><div><p>Uploads the content of a project to Design Center</p></div></div></td></tr></tbody></table>

## DX Mule

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/dx-mule#dx-mule-runtime-list">dx:mule:runtime:list</a></p></div></div></td><td><div><div><p>Lists all available Mule runtime versions from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/dx-mule#dx-mule-runtime-download">dx:mule:runtime:download</a></p></div></div></td><td><div><div><p>Downloads a Mule runtime to the local machine</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/dx-mule#dx-mule-runtime-path">dx:mule:runtime:path</a></p></div></div></td><td><div><div><p>Shows or sets the path to the local Mule runtime installation</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/dx-mule#dx-mule-project-create">dx:mule:project:create</a></p></div></div></td><td><div><div><p>Scaffolds a new Mule project with Maven structure and connector dependencies</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/dx-mule#dx-mule-describe-connector">dx:mule:describe-connector</a></p></div></div></td><td><div><div><p>Introspects a connector’s operations, sources, configs, and connection providers</p></div></div></td></tr></tbody></table>

## Exchange Assets

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-copy">exchange:asset:copy</a></p></div></div></td><td><div><div><p>Copies an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-delete">exchange:asset:delete</a></p></div></div></td><td><div><div><p>Deletes an asset from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-deprecate">exchange:asset:deprecate</a></p></div></div></td><td><div><div><p>Deprecates an asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-describe">exchange:asset:describe</a></p></div></div></td><td><div><div><p>Shows a given asset’s information</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-download">exchange:asset:download</a></p></div></div></td><td><div><div><p>Downloads an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-list">exchange:asset:list</a></p></div></div></td><td><div><div><p>Lists all assets</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-modify">exchange:asset:modify</a></p></div></div></td><td><div><div><p>Modifies an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-mutableDataUpload">exchange:asset:mutableDataUpload</a></p></div></div></td><td><div><div><p>Modifies mutable data of an existing Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-page-delete">exchange:asset:page:delete</a></p></div></div></td><td><div><div><p>Deletes an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-page-download">exchange:asset:page:download</a></p></div></div></td><td><div><div><p>Downloads an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-page-list">exchange:asset:page:list</a></p></div></div></td><td><div><div><p>List all pages for a given asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-page-modify">exchange:asset:page:modify</a></p></div></div></td><td><div><div><p>Changes an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-page-update">exchange:asset:page:update</a></p></div></div></td><td><div><div><p>Updates an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-page-upload">exchange:asset:page:upload</a></p></div></div></td><td><div><div><p>Uploads an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-resource-delete">exchange:asset:resource:delete</a></p></div></div></td><td><div><div><p>Deletes resource from the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-resource-download">exchange:asset:resource:download</a></p></div></div></td><td><div><div><p>Downloads resource from the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-resource-list">exchange:asset:resource:list</a></p></div></div></td><td><div><div><p>Lists published resources in the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-resource-upload">exchange:asset:resource:upload</a></p></div></div></td><td><div><div><p>Uploads a resource to an asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-undeprecate">exchange:asset:undeprecate</a></p></div></div></td><td><div><div><p>Undeprecates an asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-updateStatus">exchange:asset:updateStatus</a></p></div></div></td><td><div><div><p>Modifies the status of an existing asset</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/exchange-assets#exchange-asset-upload">exchange:asset:upload</a></p></div></div></td><td><div><div><p>Uploads an Exchange asset using Exchange Experience API</p></div></div></td></tr></tbody></table>

> [!NOTE] Exchange commands are currently not available for GovCloud.

## Hybrid Applications

> [!CAUTION] For the Anypoint Platform CLI to recognize your target servers, each server must be
> manually registered with the platform.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-artifact">runtime-mgr:standalone-application:artifact</a></p></div></div></td><td><div><div><p>Downloads a standalone application artifact binary</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-copy">runtime-mgr:standalone-application:copy</a></p></div></div></td><td><div><div><p>Copies a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-delete">runtime-mgr:standalone-application:delete</a></p></div></div></td><td><div><div><p>Deletes a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-deploy">runtime-mgr:standalone-application:deploy</a></p></div></div></td><td><div><div><p>Deploys or redeploys an application to an on-premises server, server group, or cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-describe">runtime.mgr:standalone-application:describe</a></p></div></div></td><td><div><div><p>Shows detailed information for a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-list">runtime-mgr:standalone-application:list</a></p></div></div></td><td><div><div><p>Lists all standalone applications in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-modify">runtime-mgr:standalone-application:modify</a></p></div></div></td><td><div><div><p>Changes a standalone application artifact</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-restart">runtime-mgr:standalone-application:restart</a></p></div></div></td><td><div><div><p>Restarts a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-start">runtime-mgr:standalone-application:start</a></p></div></div></td><td><div><div><p>Starts a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-stop">runtime-mgr:standalone-application:stop</a></p></div></div></td><td><div><div><p>Stops a standalone application</p></div></div></td></tr></tbody></table>

## Alerts for Hybrid Applications

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-alerts#runtime-mgr-standalone-alert-create">runtime-mgr:standalone-alert:create</a></p></div></div></td><td><div><div><p>Creates new alert for standalone runtime</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-alerts#runtime-mgr-standalone-alert-describe">runtime-mgr:standalone-alert:describe</a></p></div></div></td><td><div><div><p>Describes an alert</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-alerts#runtime-mgr-standalone-alert-list">runtime-mgr:standalone-alert:list</a></p></div></div></td><td><div><div><p>Lists all alerts for standalone runtimes in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/standalone-alerts#runtime-mgr-standalone-alert-modify">runtime-mgr:standalone-alert:modify</a></p></div></div></td><td><div><div><p>Modifies alert for standalone runtime</p></div></div></td></tr></tbody></table>

## Local Servers

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/servers#runtime-mgr-server-describe">runtime-mgr:server:describe</a></p></div></div></td><td><div><div><p>Describes server</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/servers#runtime-mgr-server-delete">runtime-mgr:server:delete</a></p></div></div></td><td><div><div><p>Deletes server</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/servers#runtime-mgr-server-list">runtime-mgr:server:list</a></p></div></div></td><td><div><div><p>Changes an standalone application artifact</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/servers#runtime-mgr-server-modify">runtime-mgr:server:modify</a></p></div></div></td><td><div><div><p>Modifies server</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/servers#runtime-mgr-server-token">runtime-mgr:server:token</a></p></div></div></td><td><div><div><p>Gets server registration token. This token needs to be used to register a new server</p></div></div></td></tr></tbody></table>

## Local Server Clusters

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-clusters#runtime-mgr-cluster-add-server">runtime-mgr:cluster:add:server</a></p></div></div></td><td><div><div><p>Adds server to cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-clusters#runtime-mgr-cluster-create">runtime-mgr:cluster:create</a></p></div></div></td><td><div><div><p>Creates new cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-clusters#runtime-mgr-cluster-describe">runtime-mgr:cluster:describe</a></p></div></div></td><td><div><div><p>Describes server cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-clusters#runtime-mgr-cluster-delete">runtime-mgr:cluster:delete</a></p></div></div></td><td><div><div><p>Deletes cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-clusters#runtime-mgr-cluster-modify">runtime-mgr:cluster:modify</a></p></div></div></td><td><div><div><p>Modifies cluster</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-clusters#runtime-mgr-cluster-list">runtime-mgr:cluster:list</a></p></div></div></td><td><div><div><p>Lists all clusters in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-clusters#runtime-mgr-cluster-remove-server">runtime-mgr:cluster:remove:server</a></p></div></div></td><td><div><div><p>Removes server from a cluster</p></div></div></td></tr></tbody></table>

## Local Server Groups

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-groups#runtime-mgr-servergroup-add-server">runtime-mgr:serverGroup:add:server</a></p></div></div></td><td><div><div><p>Adds server to a server group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-groups#runtime-mgr-servergroup-create">runtime-mgr:serverGroup:create</a></p></div></div></td><td><div><div><p>Creates server group from servers</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-groups#runtime-mgr-servergroup-describe">runtime-mgr:serverGroup:describe</a></p></div></div></td><td><div><div><p>Describes server group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-groups#runtime-mgr-servergroup-delete">runtime-mgr:serverGroup:delete</a></p></div></div></td><td><div><div><p>Deletes server group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-groups#runtime-mgr-servergroup-list">runtime-mgr:serverGroup:list</a></p></div></div></td><td><div><div><p>Lists all server groups in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-groups#runtime-mgr-servergroup-modify">runtime-mgr:serverGroup:modify</a></p></div></div></td><td><div><div><p>Modifies server group</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/server-groups#runtime-mgr-servergroup-remove-server">runtime-mgr:serverGroup:remove:server</a></p></div></div></td><td><div><div><p>Removes server from a server group</p></div></div></td></tr></tbody></table>

## Managed Omni Gateways

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/managed-gateways#runtime-mgr-gateways-managed-create">runtime-mgr:gateways:managed:create</a></p></div></div></td><td><div><div><p>Create a Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/managed-gateways#runtime-mgr-gateways-managed-delete">runtime-mgr:gateways:managed:delete</a></p></div></div></td><td><div><div><p>Delete a Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/managed-gateways#runtime-mgr-gateways-managed-describe">runtime-mgr:gateways:managed:describe</a></p></div></div></td><td><div><div><p>Describe a specific Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/managed-gateways#runtime-mgr-gateways-managed-edit">runtime-mgr:gateways:managed:edit</a></p></div></div></td><td><div><div><p>Edit a Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/managed-gateways#runtime-mgr-gateways-managed-list">runtime-mgr:gateways:managed:list</a></p></div></div></td><td><div><div><p>Lists all Managed Omni Gateways in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/managed-gateways#runtime-mgr-gateways-managed-start">runtime-mgr:gateways:managed:start</a></p></div></div></td><td><div><div><p>Start a Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/managed-gateways#runtime-mgr-gateways-managed-stop">runtime-mgr:gateways:managed:stop</a></p></div></div></td><td><div><div><p>Stop a Managed Omni Gateway</p></div></div></td></tr></tbody></table>

## PDK Policy Projects

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/pdk-plugin#policy-project-create">policy-project:create</a></p></div></div></td><td><div><div><p>Creates a custom policy definition project</p></div></div></td></tr></tbody></table>

## See Also

- [Anypoint Exchange Documentation](https://docs.mulesoft.com/exchange/)

- [Access Management Documentation](https://docs.mulesoft.com/access-management/)

- [Anypoint Runtime Manager Documentation](https://docs.mulesoft.com/runtime-manager/)

- [VPC Documentation](https://docs.mulesoft.com/cloudhub/virtual-private-cloud)

- [CloudHub Load Balancers Documentation](https://docs.mulesoft.com/cloudhub/cloudhub-dedicated-load-balancer)

- [API Manager 2.x (Crowd Release) Documentation](https://docs.mulesoft.com/api-manager/latest/)

- [Design Center Documentation](https://docs.mulesoft.com/design-center/)

<!-- document id=085717cb17372370913ef494cd1c31ad183a98a59ab00f39e1521a51c9691a1f url=/mulesoft/current/en-us/anypoint-cli/latest/index.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Anypoint Platform CLI 4.x Overview

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

Anypoint Platform CLI provides scripting and command-line capabilities for Anypoint Platform and
Anypoint Platform Private Cloud Edition (PCE). Use the CLI to automate platform operations, manage
applications, and integrate with CI/CD pipelines. The tool enables developers and administrators to
perform common tasks efficiently through command-line interfaces. CLI supports both cloud and
on-premises deployments, enabling support for various enterprise environments.

Use Anypoint Platform CLI commands to automate a subset of product actions through scripts. Anypoint
Platform CLI 4.0 and later can be run only in batch mode. Interactive mode is no longer supported.

With Anypoint CLI 4.x you can:

- Enhance your workflow efficiency:  
  Streamline your API management and development processes with command-line tools.

- Ensure consistency across environments and organizations:  
  Apply consistent configurations and policies across different organizations and environments,
  ensuring stability and reliability in your operations.

- Manage your applications effectively:  
  Perform a wide range of operations on your APIs and applications, from deployment to monitoring,
  all from the command line.

> [!WARNING] Anypoint Platform CLI 4.x is not backward compatible. If you are using a version of
> Anypoint CLI earlier than Anypoint CLI 4.x,
> [read this first to find out about differences.](https://docs.mulesoft.com/anypoint-cli/latest/diff-earlier-ver)

## Before you begin

Because the Anypoint CLI is built with Node.js, you must:

1.  Install the Node package manager (npm)

2.  Install the Anypoint CLI using npm

    After the Anypoint CLI installation, you can run the commands.

For more information, refer to [Install Anypoint CLI](https://docs.mulesoft.com/anypoint-cli/latest/install).

## Syntax

The Anypoint Platform CLI command set has the following syntax:

```console
$ anypoint-cli-v4 [command]  [parameters] [flags]
```

If you run a command and there is an error, the application exits and returns a description of the
issue.

When using multi-option flags in a command, either put the parameter before the flags:

```console
anypoint-cli-v4 governance:api:validate param1 param2 --rulesets value1 --rulesets value2 --rulesets value3
```

Or use a `--` (two dashes followed by a space) before the parameter:

```console
anypoint-cli-v4 governance:api:validate --rulesets value1 --rulesets value2 --rulesets value3 -- param1 param2
```

> [!NOTE] You can write all commands separated by spaces or colons. For example:
> `runtime-mgr:application:list` can also be `runtime-mgr application list`.

## Default Flags

Anypoint Platform CLI commands have the following default flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--help</code></p></div></div></td><td><div><div><p>Displays command usage information</p></div></div></td></tr><tr><td><div><div><p><code>--organization</code></p></div></div></td><td><div><div><p>Your organization within Anypoint Platform</p></div><div><p>You can also pass this value using the environment variable <code>export ANYPOINT_ORG=&lt;name&gt;</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--environment</code></p></div></div></td><td><div><div><p>Your Anypoint Platform environment</p></div><div><p>You can also pass this value using the environment variable <code>export ANYPOINT_ENV=&lt;name&gt;</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--host</code></p></div></div></td><td><div><div><p>The host of your Anypoint Platform Installation<br>This value defaults to <code>anypoint.mulesoft.com</code>.<br></p></div><div><ul><li><p>If you are using Anypoint Platform PCE, pass the address where you are hosting the platform.</p></li><li><p>If you are using Anypoint Platform EU Cloud, pass your EU control plane URL.</p></li></ul></div><div><p>You can also pass this value using a dedicated environment variable <code>ANYPOINT_HOST=&lt;name&gt;</code>. For example, <code>ANYPOINT_HOST=my.anypoint.mulesoft.com</code>.</p></div></div></td></tr></tbody></table>

## Override Order

You can use environment variables to define values in Anypoint CLI. Following is the override order
if you mix environment variable settings with explicit command line values:

- Environment variables override credentials file parameters.

- Command-line parameters override environment variables.

- If you do not pass a command-line flag, the default profile properties are used.

- If you do not specify an environment, the default is production.

## Session Timeout

Your Anypoint Platform session expires based on the **Default session timeout** configured in your
Organization settings.

For information about Root Organization settings, see
[Manage Root Organization Settings](https://docs.mulesoft.com/access-management/managing-business-groups#manage-root-organization-settings).

## Anonymized Usage Data

To improve the Anypoint CLI experience, MuleSoft gathers anonymized usage data. You can opt out by
setting `collectMetrics` to false in the `credentials` file.

## See also

1.  [Install](https://docs.mulesoft.com/anypoint-cli/latest/install) Anypoint CLI.

2.  [Authenticate to Anypoint Platform](https://docs.mulesoft.com/anypoint-cli/latest/auth).

3.  [View the list of commands](https://docs.mulesoft.com/anypoint-cli/latest/anypoint-platform-cli-commands) available for the Anypoint Platform
    actions you can execute using Anypoint CLI.

4.  [Use a Proxy Server](https://docs.mulesoft.com/anypoint-cli/latest/proxy).

<!-- document id=64300116cf9530fc6b8559a0d7008144c195052924a3f53a2726ce77c0235df3 url=/mulesoft/current/en-us/anypoint-cli/latest/anypoint-cli-release-notes.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Anypoint Platform CLI Release Notes

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

Anypoint Platform CLI is a scripting and command-line tool for Anypoint Platform and Anypoint
Platform Private Cloud Edition (Anypoint Platform PCE).

The following release notes are provided for Anypoint Platform CLI:

- [Anypoint Platform CLI 4.x](https://docs.mulesoft.com/release-notes/cli/anypoint-platform-cli-4)

- [Anypoint Platform CLI 3.x](https://docs.mulesoft.com/release-notes/cli/anypoint-platform-cli)

## See Also

- [Anypoint CLI Documentation](https://docs.mulesoft.com/anypoint-cli/latest/)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=fe1ec031e51d2c6807484227b28417b766580f3e1b9338f725b8ff4a1963fe85 url=/mulesoft/current/en-us/anypoint-cli/latest/api-catalog.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# API Catalog CLI

> 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="#autocomplete-command">api-catalog autocomplete</a></p></div></div></td><td><div><div><p>Configures autocompletion for API Catalog commands</p></div></div></td></tr><tr><td><div><div><p><a href="#conf-command">api-catalog conf</a></p></div></div></td><td><div><div><p>Creates or deletes a credentials configuration file</p></div></div></td></tr><tr><td><div><div><p><a href="#create-descriptor-command">api-catalog create-descriptor</a></p></div></div></td><td><div><div><p>Creates a descriptor file</p></div></div></td></tr><tr><td><div><div><p><a href="#update-descriptor-command">api-catalog update-descriptor</a></p></div></div></td><td><div><div><p>Updates a descriptor file</p></div></div></td></tr><tr><td><div><div><p><a href="#publish-asset-command">api-catalog publish-asset</a></p></div></div></td><td><div><div><p>Publishes assets to Exchange</p></div></div></td></tr></tbody></table>

Discover and catalog your API definitions, documentation files, and associated metadata as part of
an automated process with API Catalog CLI. You can embed the publish asset command in your
automation tools, such as a CI/CD pipeline or custom scripts, to automatically trigger the
publishing of your API assets to Exchange. API Catalog CLI is agnostic of CI/CD tools and runtime
environments.

See [Autocataloging APIs Using API Catalog CLI](https://docs.mulesoft.com/exchange/apicat-about-api-catalog-cli).

## api-catalog autocomplete

$ api-catalog autocomplete \[flags\]

This command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>blank</p></div></div></td><td><div><div><p>Displays instructions for configuring autocompletion</p></div></div></td></tr><tr><td><div><div><p>bash</p></div></div></td><td><div><div><p>Installs autocompletion using Bash shell settings</p></div></div></td></tr><tr><td><div><div><p>zsh</p></div></div></td><td><div><div><p>Installs autocompletion using Z shell settings</p></div></div></td></tr><tr><td><div><div><p>-r, --refresh cache</p></div></div></td><td><div><div><p>Removes the current autocompletion configuration. Use this before running the command with a different shell type.</p></div></div></td></tr></tbody></table>

**Examples**

$ api-catalog autocomplete
$ api-catalog autocomplete bash $ api-catalog autocomplete zsh
$
api-catalog autocomplete --refresh-cache

> [!WARNING] The API Catalog CLI autocomplete plugin is not currently supported in Windows.

## api-catalog conf

Manage authentication credentials in a configuration file (config.json) by adding and removing key
value pairs. Set one key value pair per command execution.

\> api-catalog conf <authkey> <authkeyvalue> \[flags\]

`<authkey>`  
The authentication key name. Possible key names are: username password client\_id client\_secret
host environment organization

`<authkeyvalue>`  
The value for the specified authentication key.

This command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>-d</code>, <code>--delete</code></p></div></div></td><td><div><div><p>Deletes the config file entry for the given key</p></div></div></td></tr><tr><td><div><div><p><code>-h</code>, <code>--help</code></p></div></div></td><td><div><div><p>Shows the help for this command</p></div></div></td></tr><tr><td><div><div><p><code>-k</code>, <code>--key=key</code></p></div></div></td><td><div><div><p>Shows the value that corresponds with the given key</p></div></div></td></tr><tr><td><div><div><p><code>-v</code>, <code>--value=value</code></p></div></div></td><td><div><div><p>Shows the key that corresponds with the given value</p></div></div></td></tr></tbody></table>

## api-catalog create-descriptor

\> api-catalog create-descriptor \[flags\]

This command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>-d</code>, <code>--file=file</code></p></div></div></td><td><div><div><p>Default: <code>catalog.yaml</code></p></div><div><p>The name and location in which to save the generated catalog descriptor file</p></div></div></td></tr><tr><td><div><div><p><code>--external</code></p></div></div></td><td><div><div><p>Generates an <code>exchange.json</code> file for each API described in the descriptor file and adds a reference to each of those in the descriptor file using the <code>ref</code> tag in the <code>projects</code> section</p></div></div></td></tr></tbody></table>

## api-catalog update-descriptor

\> api-catalog update-descriptor \[flags\]

This command accepts the following flag:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>-d</code>, <code>--descriptor-file=descriptor-file</code></p></div></div></td><td><div><div><p>Default: <code>catalog.yaml</code></p></div><div><p>The name and location in which to save the updated catalog descriptor file information</p></div></div></td></tr></tbody></table>

## api-catalog publish-asset

\> api-catalog publish-asset \[flags\]

This command accepts the
[general and authentication flags](https://docs.mulesoft.com/exchange/apicat-use-api-catalog-cli#common-options) in
addition to the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--async</code></p></div></div></td><td><div><div><p>Runs the publish job asynchronously.</p></div></div></td></tr><tr><td><div><div><p><code>-d</code>, <code>--descriptor-file=descriptor-file</code></p></div><div><p>or</p></div><div><p>ANYPOINT_DESCRIPTOR_FILE environment variable</p></div></div></td><td><div><div><p>Default: ./catalog.yaml</p></div><div><p>The name and location of the catalog descriptor file.</p></div><div><ul><li><p>If the file does not exist, no assets are cataloged.</p></li><li><p>If the file exists but is empty, the command creates and prints the catalog descriptor YAML results. It outputs cataloging information for all API definitions it finds in the full directory tree relative to the current working directory.</p></li><li><p>If a valid YAML file exists, the command catalogs the assets as specified.</p></li></ul></div><div><p>See <a href="https://docs.mulesoft.com/exchange/apicat-create-descriptor-file-cli#create-desc-file-cli">Create a Descriptor File Using the CLI</a>.</p></div></div></td></tr><tr><td><div><div><p><code>--dry-run</code></p></div></div></td><td><div><div><p>Runs the command to verify that the descriptor file is valid. No APIs are published.</p></div></div></td></tr><tr><td><div><div><p><code>--force-publish</code></p></div></div></td><td><div><div><p>Bypasses the comparison and creates a new version of the asset in Exchange regardless of the content.</p></div></div></td></tr><tr><td><div><div><p><code>--force-update-metadata</code></p></div></div></td><td><div><div><p>Updates the asset’s metadata, such as tags, in the latest version in Exchange regardless of the content. This does not republish the asset.</p></div></div></td></tr><tr><td><div><div><p><code>--json</code></p></div></div></td><td><div><div><p>Prints the execution result in JSON format.</p></div></div></td></tr><tr><td><div><div><p><code>-s</code>, <code>--silent</code></p></div></div></td><td><div><div><p>Enables silent logging.</p></div></div></td></tr><tr><td><div><div><p><code>-t</code>, <code>--trigger-criteria=&lt;descriptor-tag&gt;:&lt;value&gt;</code> <code>--trigger-criteria=&lt;descriptor-tag&gt;:value</code></p></div></div></td><td><div><div><p>This flag works in conjunction with the <code>triggerConditions</code> section in the descriptor file. For each run of the <code>api-catalog publish-asset</code> command, the trigger values are compared to trigger condition values in the descriptor file to determine whether to publish the APIs described in the descriptor file. To match multiple conditions, specify separate <code>--trigger-criteria</code> flags for each condition. For the APIs to be published, all trigger conditions set in the descriptor file must be matched by <code>--trigger-criteria</code> flag values.</p></div><div><p>Example:</p></div><div><p><code>--trigger-criteria=branch:main --trigger-criteria=anytag:release/ --trigger=user:admin</code></p></div><div><p>See <a href="https://docs.mulesoft.com/exchange/apicat-create-descriptor-file-manually#descriptor-yaml">Descriptor YAML Schema</a>.</p></div></div></td></tr><tr><td><div><div><p><code>-v</code>, <code>--verbose</code></p></div></div></td><td><div><div><p>Enables verbose logging.</p></div></div></td></tr><tr><td><div><div><p><code>--version-strategy-criteria=&lt;descriptor-tag&gt;:&lt;value&gt;</code></p></div></div></td><td><div><div><p>This flag works in conjunction with the <code>versionStrategyConditions</code> section in the descriptor file. The <code>api-catalog publish-asset</code> command compares the version strategy criteria values to version strategy condition values in the descriptor file to determine the version strategy to use to publish the APIs. To match multiple conditions, specify separate <code>--version-strategy-criteria</code> flags for each condition.</p></div><div><p>Example:</p></div><div><p><code>--version-strategy-criteria=branch:main --version-strategy-criteria=anytag:release/ --version-strategy-criteria=user:admin</code></p></div><div><p>See <a href="https://docs.mulesoft.com/exchange/apicat-create-descriptor-file-manually#descriptor-yaml">Descriptor YAML Schema</a>.</p></div></div></td></tr></tbody></table>

## General and Authentication Flags

Following are the general and authentication flags for commands that authenticate to Anypoint
Platform:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--client_id=client_id</code></p></div><div><p>or</p></div><div><p><code>ANYPOINT_CLIENT_ID</code> environment variable</p></div></div></td><td><div><div><p>Connected app client ID</p></div><div><p>See <a href="https://docs.mulesoft.com/exchange/apicat-use-api-catalog-cli#authentication">Authentication</a>.</p></div></div></td></tr><tr><td><div><div><p><code>--client_secret</code></p></div><div><p>or</p></div><div><p><code>ANYPOINT_CLIENT_SECRET</code> environment variable</p></div></div></td><td><div><div><p>Prompt for the connected app secret for the client ID</p></div><div><p>See <a href="https://docs.mulesoft.com/exchange/apicat-use-api-catalog-cli#authentication">Authentication</a>.</p></div></div></td></tr><tr><td><div><div><p><code>--collectMetrics</code></p></div><div><p>or</p></div><div><p><code>COLLECT_METRICS</code> environment variable</p></div></div></td><td><div><div><p>Not currently used</p></div></div></td></tr><tr><td><div><div><p><code>--environment=environment</code></p></div><div><p>or</p></div><div><p><code>ANYPOINT_ENV</code> environment variable</p></div></div></td><td><div><div><p>The name of the Anypoint Platform environment where the APIs are cataloged</p></div></div></td></tr><tr><td><div><div><p><code>--host=host</code></p></div><div><p>or</p></div><div><p><code>ANYPOINT_HOST</code> environment variable</p></div></div></td><td><div><div><p>Default:</p></div><div><div><pre>anypoint.mulesoft.com</pre></div></div><div><p>The Anypoint Platform base URL without the protocol</p></div><div><p>For the US Anypoint Platform, use:</p></div><div><div><pre>anypoint.mulesoft.com</pre></div></div><div><p>For the European Anypoint Platform, use:</p></div><div><div><pre>eu1.anypoint.mulesoft.com</pre></div></div></div></td></tr><tr><td><div><div><p><code>--organization=organization</code></p></div><div><p>or</p></div><div><p><code>ANYPOINT_ORG</code> environment variable</p></div></div></td><td><div><div><p>The ID of the Anypoint Platform organization where the APIs are cataloged</p></div></div></td></tr><tr><td><div><div><p><code>-p</code>, <code>--password</code></p></div><div><p>or</p></div><div><p><code>ANYPOINT_PASSWORD</code> environment variable</p></div></div></td><td><div><div><p>Anypoint user password</p></div><div><p>See <a href="https://docs.mulesoft.com/exchange/apicat-use-api-catalog-cli#authentication">Authentication</a>.</p></div></div></td></tr><tr><td><div><div><p><code>-u</code>, <code>--username=username</code></p></div><div><p>or</p></div><div><p><code>ANYPOINT_USERNAME</code> environment variable</p></div></div></td><td><div><div><p>Anypoint username</p></div><div><p>See <a href="https://docs.mulesoft.com/exchange/apicat-use-api-catalog-cli#authentication">Authentication</a>.</p></div></div></td></tr></tbody></table>

<!-- document id=b61240829fa352b5124332c8843f65277282ac034f70e62cf4d51d5b327b32a8 url=/mulesoft/current/en-us/anypoint-cli/latest/auth.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Authentication to the Anypoint Platform CLI

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

To authenticate to Anypoint CLI, you must use one of the authentication option combinations:

- Username and password

- Client ID and client secret

- Bearer token (command line only)

> [!NOTE] As a part of Multi-factor authentication (MFA) enablement for all users, starting October
> 2022, the only way to use Anypoint CLI will be through
> [Connected Apps](https://docs.mulesoft.com/access-management/connected-apps-overview).

The default host, environment, and organization are used if you do not specify them.

Pass Anypoint CLI credentials by using the following methods:

- [Using a credentials configuration file](#credentials-file)

- [Using command-line parameters and Environment Variables](#command-line-parameters)

Configuration settings are overridden as follows:

- Command-line parameters override all other methods.

- Environment variables are used if command-line parameters are not specified and override any
  credentials configuration file settings.

- Credentials configuration file parameters are used if no command-line parameters or environment
  variables are set.

## Set Credentials Using the Conf command

You can authenticate to Anypoint Platform by running the `anypoint-cli-v4` command with the `conf`
option to add your credentials to a configuration file and then running the `anypoint-cli-v4`
commands you want to use. You can set authentication values in the configuration file using a
combination of the following parameters:

username password client\_id client\_secret host session.selectedEnvironment.id
session.selectedOrganization.id

To create your configuration file:

- Run the `anypoint-cli-v4 conf` command with the parameters you want to use to set the
  authentication method. For example, the following command sets the username and password.

  $ anypoint-cli-v4 conf username <username>
    $ anypoint-cli-v4 conf password <password>

The commands store the credential information in the `config.json` file in the following locations:

- MacOS: `~/Library/Preferences/anypoint-cli-v4-nodejs/config.json`

- Windows: `%APPDATA%\anypoint-cli-v4-nodejs\Config`

- Unix: `~/.config/anypoint-cli-v4-nodejs/`

**Examples:**

- Set configuration file authentication using username and password

  - Add authentication values to the configuration file using the following commands:

    $ anypoint-cli-v4 conf username myUserName
        $ anypoint-cli-v4 conf password myPassword $
    anypoint-cli-v4 conf organization myOrgId

  - Run a command and the authentication will be done using the configuration file values.

    $ anypoint-cli-v4 account:environment:list

- Set configuration file authentication using client ID and client secret

  - Add authentication values to the configuration file using the following commands:

    $ anypoint-cli-v4 conf client\_id myClientID
        $ anypoint-cli-v4 conf client\_secret
    myCLientSecret $ anypoint-cli-v4 conf organization myOrgId

  - Run a command and the authentication will be done using the configuration file values.

    $ anypoint-cli-v4 account:environment:list

    The `organization` flag is optional. It defaults to your main organization from Anypoint
    Platform.

> [!NOTE] You can get your `client_id` and `client_secret` via Connected Apps. For more information
> see [Connected Apps for Developers](https://docs.mulesoft.com/access-management/connected-apps-developers).
>
> Connected Apps require the `View Organization` and `View Environment` scopes to authenticate to
> Anypoint Platform.

## Command-Line Parameters and Environment Variables

You can authenticate to Anypoint Platform through the command line by running the `anypoint-cli-v4`
command with a combination of parameters, or by setting a combination of the following environment
variables before running the `anypoint-cli-v4` command:

<table><colgroup><col> <col></colgroup><thead><tr><th>Command-Line Parameters</th><th>Environment Variables</th></tr></thead><tbody><tr><td><div><div><p><code>--username</code></p></div></div></td><td><div><div><p><code>ANYPOINT_USERNAME</code></p></div></div></td></tr><tr><td><div><div><p><code>--password</code></p></div></div></td><td><div><div><p><code>ANYPOINT_PASSWORD</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_id</code></p></div></div></td><td><div><div><p><code>ANYPOINT_CLIENT_ID</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_secret</code></p></div></div></td><td><div><div><p><code>ANYPOINT_CLIENT_SECRET</code></p></div></div></td></tr><tr><td><div><div><p><code>--bearer</code></p></div></div></td><td><div><div><p><code>ANYPOINT_BEARER</code></p></div></div></td></tr><tr><td><div><div><p><code>--organization</code></p></div></div></td><td><div><div><p><code>ANYPOINT_ORG</code></p></div></div></td></tr><tr><td><div><div><p><code>--environment</code></p></div></div></td><td><div><div><p><code>ANYPOINT_ENV</code></p></div></div></td></tr><tr><td><div><div><p>-</p></div></div></td><td><div><div><p><code>ANYPOINT_CERTIFICATE</code></p></div></div></td></tr><tr><td><div><div><p>-</p></div></div></td><td><div><div><p><code>ANYPOINT_HOST</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]collectMetrics</code></p></div></div></td><td><div><div><p><code>COLLECT_METRICS</code></p></div></div></td></tr></tbody></table>

> [!NOTE] The `--organization` flag is optional. It defaults to your main organization from Anypoint
> Platform.

**Examples:**

- Authenticate on the command line using username and password

  $ anypoint-cli-v4 account:environment:list --username myUserName --password myPassword
  --organization myOrgId

- Authenticate on the command line using client ID and client secret

  $ anypoint-cli-v4 account:environment:list --client\_id myClientID --client\_secret myClientSecret
  --organization myOrgId

- Authenticate on the command line using a bearer token

  You can generate a bearer token in Anypoint Platform and pass it to Anypoint CLI directly. When
  you provide a bearer token, Anypoint CLI ignores any provided user or client credentials.

  $ anypoint-cli-v4 account:environment:list --bearer myBearerToken --organization myOrgId

  Your Anypoint Platform session expires when the bearer token expires.

  For information about generating a bearer token, see
  [How to Generate Your Authorization Bearer Token for Anypoint Platform](https://help.salesforce.com/s/articleView?id=001115323&type=1).

- Authenticate by setting the environment variables for username and password

  $ export ANYPOINT\_USERNAME=myUserName
    $ export ANYPOINT\_PASSWORD=myPassword
  $ export ANYPOINT\_ORG=myOrgId
    $ anypoint-cli-v4 account:environment:list

- Authenticate by setting the environment variables for client ID and client secret

  $ export ANYPOINT\_CLIENT\_ID=myClientID
    $ export ANYPOINT\_CLIENT\_SECRET=myCLientSecret
  $ export ANYPOINT\_ORG=myOrgId
    $ anypoint-cli-v4 account:environment:list

<!-- document id=129f53a5e8e2b9f441afdefaa0807fdbb8a782ec9edc339d667ec99da20bcc55 url=/mulesoft/current/en-us/anypoint-cli/latest/agent-fabric.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Agent Fabric Plugin

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

Use these commands to author, publish, and deploy agent network projects.

> [!IMPORTANT] The Agent Fabric commands come from a separate plugin,
> `mulesoft-anypoint-cli-agent-fabric-plugin`, that isn’t included in the base Anypoint CLI
> installation. Install it before you use these commands, using either of these methods:
>
> - As an Anypoint CLI plugin: see [Install a Plugin Separately](https://docs.mulesoft.com/anypoint-cli/latest/install#install-plugins).
>
> - As a standalone tool for
>   [building agent networks in a CI/CD pipeline](https://docs.mulesoft.com/agent-network/latest/af-build-agent-networks-in-a-ci-cd-environment)
>   through npm: run `npm install mulesoft-anypoint-cli-agent-fabric-plugin`.
>
> Run these commands with the `anypoint-cli-agent-fabric-plugin` executable, as shown in the
> examples.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#agent-network-project-build">agent-network:project:build</a></p></div></div></td><td><div><div><p>Builds the agent network project and validates configuration</p></div></div></td></tr><tr><td><div><div><p><a href="#agent-network-project-create">agent-network:project:create</a></p></div></div></td><td><div><div><p>Creates a new agent network project and generates the initial configuration files</p></div></div></td></tr><tr><td><div><div><p><a href="#agent-network-project-deploy">agent-network:project:deploy</a></p></div></div></td><td><div><div><p>Deploys the agent network project to the target environment</p></div></div></td></tr><tr><td><div><div><p><a href="#agent-network-project-publish">agent-network:project:publish</a></p></div></div></td><td><div><div><p>Publishes the agent network project to Anypoint Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#agent-network-project-undeploy">agent-network:project:undeploy</a></p></div></div></td><td><div><div><p>Undeploys the agent network project and removes all deployed runtime resources</p></div></div></td></tr><tr><td><div><div><p><a href="#agent-network-project-unpublish">agent-network:project:unpublish</a></p></div></div></td><td><div><div><p>Unpublishes the agent network project asset versions from Anypoint Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#agent-network-setup-gateways">agent-network:setup:gateways</a></p></div></div></td><td><div><div><p>Sets up the gateways for the agent network</p></div></div></td></tr></tbody></table>

## agent-network:project:build

\> anypoint-cli-agent-fabric-plugin agent-network project build \[flags\]

Builds the current agent network project using the Maven wrapper (`mvnw` or `mvnw.cmd`). This
command validates the configuration and generates the artifacts required for publishing and
deployment.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--bearer &lt;value&gt;</code></p></div></div></td><td><div><div><p>Bearer token<br>You can also set it with <code>ANYPOINT_BEARER</code> env variable</p></div></div></td><td><div><div><p><code>--bearer myBearerToken</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client ID<br>You can also set it with the <code>ANYPOINT_CLIENT_ID</code> env variable</p></div></div></td><td><div><div><p><code>--client_id myClientID</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_secret &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client Secret<br>You can also set it with the <code>ANYPOINT_CLIENT_SECRET</code> env variable</p></div></div></td><td><div><div><p><code>--client_secret myClientSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]collectMetrics</code></p></div></div></td><td><div><div><p>Collect metrics<br>You can also set it with the <code>COLLECT_METRICS</code> env variable</p></div></div></td><td><div><div><p><code>--no-collectMetrics</code></p></div></div></td></tr><tr><td><div><div><p><code>--debug</code></p></div></div></td><td><div><div><p>Enable debug mode</p></div></div></td><td><div><div><p><code>--debug</code></p></div></div></td></tr><tr><td><div><div><p><code>--environment &lt;value&gt;</code></p></div></div></td><td><div><div><p>Environment name<br>You can also set it with the <code>ANYPOINT_ENV</code> variable</p></div></div></td><td><div><div><p><code>--environment Sandbox</code></p></div></div></td></tr><tr><td><div><div><p><code>--forceUpdate</code></p></div></div></td><td><div><div><p>Force update the dependencies</p></div></div></td><td><div><div><p><code>--forceUpdate</code></p></div></div></td></tr><tr><td><div><div><p><code>--host &lt;value&gt;</code></p></div></div></td><td><div><div><p>Host URL<br>Default: <code>anypoint.mulesoft.com</code><br>You can also set it with the <code>ANYPOINT_HOST</code> variable</p></div></div></td><td><div><div><p><code>--host mycompany.anypoint.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--organization &lt;value&gt;</code></p></div></div></td><td><div><div><p>Organization name<br>You can also set it with the <code>ANYPOINT_ORG</code> variable</p></div></div></td><td><div><div><p><code>--organization MyOrg</code></p></div></div></td></tr><tr><td><div><div><p><code>--password &lt;value&gt;</code></p></div></div></td><td><div><div><p>Password<br>You can also set it with the <code>ANYPOINT_PASSWORD</code> variable</p></div></div></td><td><div><div><p><code>--password myPassword</code></p></div></div></td></tr><tr><td><div><div><p><code>--path &lt;value&gt;</code></p></div></div></td><td><div><div><p>Path to the project<br>Default: <code>.</code></p></div></div></td><td><div><div><p><code>--path ./my-agent-network</code></p></div></div></td></tr><tr><td><div><div><p><code>--username &lt;value&gt;</code></p></div></div></td><td><div><div><p>Username<br>You can also set it with the <code>ANYPOINT_USERNAME</code> variable</p></div></div></td><td><div><div><p><code>--username myuser@example.com</code></p></div></div></td></tr></tbody></table>

### Example

$ anypoint-cli-agent-fabric-plugin agent-network project build

## agent-network:project:create

\> anypoint-cli-agent-fabric-plugin agent-network project create --name <projectName> \[flags\]

Creates a new agent network project in the current directory. The command generates a project folder
with initial configuration files, including `agent-network.yaml`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-n, --name &lt;value&gt;</code></p></div></div></td><td><div><div><p>(Required) Name of the project</p></div></div></td><td><div><div><p><code>--name my-agent-network</code></p></div></div></td></tr><tr><td><div><div><p><code>-o, --output-dir &lt;value&gt;</code></p></div></div></td><td><div><div><p>Output directory for the project</p></div></div></td><td><div><div><p><code>--output-dir ./projects</code></p></div></div></td></tr><tr><td><div><div><p><code>--api-version &lt;value&gt;</code></p></div></div></td><td><div><div><p>API version<br>Default: <code>v1</code></p></div></div></td><td><div><div><p><code>--api-version v2</code></p></div></div></td></tr><tr><td><div><div><p><code>--asset-id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Asset name (GAV). Valid characters are 'A-Z', 'a-z', '0-9', '_' and '-'.</p></div></div></td><td><div><div><p><code>--asset-id my-asset</code></p></div></div></td></tr><tr><td><div><div><p><code>--asset-version &lt;value&gt;</code></p></div></div></td><td><div><div><p>Asset version (GAV)<br>Default: <code>0.0.0</code></p></div></div></td><td><div><div><p><code>--asset-version 1.2.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--bearer &lt;value&gt;</code></p></div></div></td><td><div><div><p>Bearer token<br>You can also set it with the <code>ANYPOINT_BEARER</code> variable</p></div></div></td><td><div><div><p><code>--bearer myBearerToken</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client ID<br>You can also set it with the <code>ANYPOINT_CLIENT_ID</code> variable</p></div></div></td><td><div><div><p><code>--client_id myClientID</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_secret &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client Secret<br>You can also set it with the <code>ANYPOINT_CLIENT_SECRET</code> variable</p></div></div></td><td><div><div><p><code>--client_secret myClientSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]collectMetrics</code></p></div></div></td><td><div><div><p>Collect metrics<br>You can also set it with the <code>COLLECT_METRICS</code> variable</p></div></div></td><td><div><div><p><code>--no-collectMetrics</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]create-dir</code></p></div></div></td><td><div><div><p>Create a new directory under <code>output-dir</code> using the project name</p></div></div></td><td><div><div><p><code>--create-dir</code></p></div></div></td></tr><tr><td><div><div><p><code>--environment &lt;value&gt;</code></p></div></div></td><td><div><div><p>Environment name<br>You can also set it with the <code>ANYPOINT_ENV</code> variable</p></div></div></td><td><div><div><p><code>--environment Sandbox</code></p></div></div></td></tr><tr><td><div><div><p><code>--group-id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Group ID (GAV)</p></div></div></td><td><div><div><p><code>--group-id com.myorg</code></p></div></div></td></tr><tr><td><div><div><p><code>--host &lt;value&gt;</code></p></div></div></td><td><div><div><p>Host URL<br>Default: <code>anypoint.mulesoft.com</code><br>You can also set it with the <code>ANYPOINT_HOST</code> variable</p></div></div></td><td><div><div><p><code>--host mycompany.anypoint.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--organization &lt;value&gt;</code></p></div></div></td><td><div><div><p>Organization name<br>You can also set it with the <code>ANYPOINT_ORG</code> env variable</p></div></div></td><td><div><div><p><code>--organization MyOrg</code></p></div></div></td></tr><tr><td><div><div><p><code>--password &lt;value&gt;</code></p></div></div></td><td><div><div><p>Password<br>You can also set it with the <code>ANYPOINT_PASSWORD</code> variable</p></div></div></td><td><div><div><p><code>--password myPassword</code></p></div></div></td></tr><tr><td><div><div><p><code>--tab-size &lt;value&gt;</code></p></div></div></td><td><div><div><p>Tab size for indenting the API specification<br>Default: <code>2</code></p></div></div></td><td><div><div><p><code>--tab-size 4</code></p></div></div></td></tr><tr><td><div><div><p><code>--username &lt;value&gt;</code></p></div></div></td><td><div><div><p>Username<br>You can also set it with the <code>ANYPOINT_USERNAME</code> variable</p></div></div></td><td><div><div><p><code>--username myuser@example.com</code></p></div></div></td></tr></tbody></table>

### Example

$ anypoint-cli-agent-fabric-plugin agent-network project create --name my-agent-network

## agent-network:project:deploy

\> anypoint-cli-agent-fabric-plugin agent-network project deploy \[flags\]

Deploys the agent network application. By default, the command uses single-gateway mode with the
`agent-network-gw` gateway. You can override this using the `-g` flag or switch to separate-gateways
mode using `-i` and `-e` flags.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-e, --egress-gw &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the target egress gateway (separate-gateways mode; requires <code>--ingress-gw</code>). When no gateway flags are provided, deploy defaults to single-gateway mode using <code>agent-network-gw</code>.</p></div></div></td><td><div><div><p><code>--egress-gw custom-egress</code></p></div></div></td></tr><tr><td><div><div><p><code>-g, --gateway &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the gateway for single-gateway mode (recommended). Mutually exclusive with <code>--ingress-gw</code> and <code>--egress-gw</code>.</p></div></div></td><td><div><div><p><code>--gateway my-gateway</code></p></div></div></td></tr><tr><td><div><div><p><code>-i, --ingress-gw &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the target ingress gateway. Combine with <code>--egress-gw</code> for separate-gateways mode; on its own it selects single-gateway mode using this gateway. When no gateway flags are provided, deploy defaults to single-gateway mode using <code>agent-network-gw</code>.</p></div></div></td><td><div><div><p><code>--ingress-gw custom-ingress</code></p></div></div></td></tr><tr><td><div><div><p><code>-t, --target-space &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the target space to deploy. In single-gateway mode, optional; when provided it must match the gateway’s target space (validated, not used for lookup). In separate-gateways mode, defaults to <code>agent-network-space</code>.</p></div></div></td><td><div><div><p><code>--target-space my-space</code></p></div></div></td></tr><tr><td><div><div><p><code>--bearer &lt;value&gt;</code></p></div></div></td><td><div><div><p>Bearer token<br>You can also set it with the <code>ANYPOINT_BEARER</code> variable</p></div></div></td><td><div><div><p><code>--bearer myBearerToken</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client ID<br>You can also set it with the <code>ANYPOINT_CLIENT_ID</code> variable</p></div></div></td><td><div><div><p><code>--client_id myClientID</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_secret &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client Secret<br>You can also set it with the <code>ANYPOINT_CLIENT_SECRET</code> variable</p></div></div></td><td><div><div><p><code>--client_secret myClientSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]collectMetrics</code></p></div></div></td><td><div><div><p>Collect metrics<br>You can also set it with the <code>COLLECT_METRICS</code> variable</p></div></div></td><td><div><div><p><code>--no-collectMetrics</code></p></div></div></td></tr><tr><td><div><div><p><code>--disable-tracing</code></p></div></div></td><td><div><div><p>Disable tracing functionalities</p></div></div></td><td><div><div><p><code>--disable-tracing</code></p></div></div></td></tr><tr><td><div><div><p><code>--dont-wait-for-agent-network</code></p></div></div></td><td><div><div><p>Do not wait for the agent network to be ready</p></div></div></td><td><div><div><p><code>--dont-wait-for-agent-network</code></p></div></div></td></tr><tr><td><div><div><p><code>--environment &lt;value&gt;</code></p></div></div></td><td><div><div><p>Environment name<br>You can also set it with the <code>ANYPOINT_ENV</code> variable</p></div></div></td><td><div><div><p><code>--environment Sandbox</code></p></div></div></td></tr><tr><td><div><div><p><code>--host &lt;value&gt;</code></p></div></div></td><td><div><div><p>Host URL<br>Default: <code>anypoint.mulesoft.com</code><br>You can also set it with the <code>ANYPOINT_HOST</code> variable</p></div></div></td><td><div><div><p><code>--host mycompany.anypoint.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--max-retries &lt;value&gt;</code></p></div></div></td><td><div><div><p>Max retries to check the status of the deploying application<br>Default: <code>3</code></p></div></div></td><td><div><div><p><code>--max-retries 5</code></p></div></div></td></tr><tr><td><div><div><p><code>--organization &lt;value&gt;</code></p></div></div></td><td><div><div><p>Organization name<br>You can also set it with the <code>ANYPOINT_ORG</code> variable</p></div></div></td><td><div><div><p><code>--organization MyOrg</code></p></div></div></td></tr><tr><td><div><div><p><code>--password &lt;value&gt;</code></p></div></div></td><td><div><div><p>Password<br>You can also set it with the <code>ANYPOINT_PASSWORD</code> variable</p></div></div></td><td><div><div><p><code>--password myPassword</code></p></div></div></td></tr><tr><td><div><div><p><code>--path &lt;value&gt;</code></p></div></div></td><td><div><div><p>Path to the project<br>Default: <code>.</code></p></div></div></td><td><div><div><p><code>--path ./my-agent-network</code></p></div></div></td></tr><tr><td><div><div><p><code>--process-timeout &lt;value&gt;</code></p></div></div></td><td><div><div><p>Process timeout in milliseconds<br>Default: <code>600000</code></p></div></div></td><td><div><div><p><code>--process-timeout 900000</code></p></div></div></td></tr><tr><td><div><div><p><code>--property &lt;value&gt;</code></p></div></div></td><td><div><div><p>Property to override in <code>name:value</code> format</p></div></div></td><td><div><div><p><code>--property apiKey:sk-xxx</code></p></div></div></td></tr><tr><td><div><div><p><code>--request-timeout &lt;value&gt;</code></p></div></div></td><td><div><div><p>Request timeout in milliseconds<br>Default: <code>60000</code></p></div></div></td><td><div><div><p><code>--request-timeout 120000</code></p></div></div></td></tr><tr><td><div><div><p><code>--username &lt;value&gt;</code></p></div></div></td><td><div><div><p>Username<br>You can also set it with the <code>ANYPOINT_USERNAME</code> variable</p></div></div></td><td><div><div><p><code>--username myuser@example.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--json</code></p></div></div></td><td><div><div><p>Format output as JSON</p></div></div></td><td><div><div><p><code>--json</code></p></div></div></td></tr></tbody></table>

### Example

$ anypoint-cli-agent-fabric-plugin agent-network project deploy

$ anypoint-cli-agent-fabric-plugin agent-network project deploy --property apiKey:sk-xxx

$ anypoint-cli-agent-fabric-plugin agent-network project deploy --property apiKey:sk-xxx --property
role:user

$ anypoint-cli-agent-fabric-plugin agent-network project deploy --path ./my-project --property
myAgent.url:https://api.example.com

## agent-network:project:publish

\> anypoint-cli-agent-fabric-plugin agent-network project publish \[flags\]

Publishes the current agent network project to Anypoint Exchange. The command outputs links and
details for all created assets.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--bearer &lt;value&gt;</code></p></div></div></td><td><div><div><p>Bearer token<br>You can also set it with the <code>ANYPOINT_BEARER</code> variable</p></div></div></td><td><div><div><p><code>--bearer myBearerToken</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client ID<br>You can also set it with the <code>ANYPOINT_CLIENT_ID</code> variable</p></div></div></td><td><div><div><p><code>--client_id myClientID</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_secret &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client Secret<br>You can also set it with the <code>ANYPOINT_CLIENT_SECRET</code> variable</p></div></div></td><td><div><div><p><code>--client_secret myClientSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]collectMetrics</code></p></div></div></td><td><div><div><p>Collect metrics<br>You can also set it with the <code>COLLECT_METRICS</code> variable</p></div></div></td><td><div><div><p><code>--no-collectMetrics</code></p></div></div></td></tr><tr><td><div><div><p><code>--debug</code></p></div></div></td><td><div><div><p>Enable debug mode</p></div></div></td><td><div><div><p><code>--debug</code></p></div></div></td></tr><tr><td><div><div><p><code>--environment &lt;value&gt;</code></p></div></div></td><td><div><div><p>Environment name<br>You can also set it with the <code>ANYPOINT_ENV</code> variable</p></div></div></td><td><div><div><p><code>--environment Sandbox</code></p></div></div></td></tr><tr><td><div><div><p><code>--host &lt;value&gt;</code></p></div></div></td><td><div><div><p>Host URL<br>Default: <code>anypoint.mulesoft.com</code><br>You can also set it with the <code>ANYPOINT_HOST</code> variable</p></div></div></td><td><div><div><p><code>--host mycompany.anypoint.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--organization &lt;value&gt;</code></p></div></div></td><td><div><div><p>Organization name<br>You can also set it with <code>ANYPOINT_ORG</code> env variable</p></div></div></td><td><div><div><p><code>--organization MyOrg</code></p></div></div></td></tr><tr><td><div><div><p><code>--password &lt;value&gt;</code></p></div></div></td><td><div><div><p>Password<br>You can also set it with the <code>ANYPOINT_PASSWORD</code> variable</p></div></div></td><td><div><div><p><code>--password myPassword</code></p></div></div></td></tr><tr><td><div><div><p><code>--path &lt;value&gt;</code></p></div></div></td><td><div><div><p>Path to the project<br>Default: <code>.</code></p></div></div></td><td><div><div><p><code>--path ./my-agent-network</code></p></div></div></td></tr><tr><td><div><div><p><code>--username &lt;value&gt;</code></p></div></div></td><td><div><div><p>Username<br>You can also set it with the <code>ANYPOINT_USERNAME</code> variable</p></div></div></td><td><div><div><p><code>--username myuser@example.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--json</code></p></div></div></td><td><div><div><p>Format output as JSON</p></div></div></td><td><div><div><p><code>--json</code></p></div></div></td></tr></tbody></table>

### Example

$ anypoint-cli-agent-fabric-plugin agent-network project publish

## agent-network:project:undeploy

\> anypoint-cli-agent-fabric-plugin agent-network project undeploy \[flags\]

Undeploys the agent network application, removing all deployed resources.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--api-version &lt;value&gt;</code></p></div></div></td><td><div><div><p>API version used to discover remotely deployed resources when using <code>--gav</code><br>Default: <code>v1</code></p></div></div></td><td><div><div><p><code>--api-version v1</code></p></div></div></td></tr><tr><td><div><div><p><code>--bearer &lt;value&gt;</code></p></div></div></td><td><div><div><p>Bearer token<br>You can also set it with the <code>ANYPOINT_BEARER</code> variable</p></div></div></td><td><div><div><p><code>--bearer myBearerToken</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client ID<br>You can also set it with the <code>ANYPOINT_CLIENT_ID</code> variable</p></div></div></td><td><div><div><p><code>--client_id myClientID</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_secret &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client Secret<br>You can also set it with the <code>ANYPOINT_CLIENT_SECRET</code> variable</p></div></div></td><td><div><div><p><code>--client_secret myClientSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]collectMetrics</code></p></div></div></td><td><div><div><p>Collect metrics<br>You can also set it with the <code>COLLECT_METRICS</code> variable</p></div></div></td><td><div><div><p><code>--no-collectMetrics</code></p></div></div></td></tr><tr><td><div><div><p><code>--dry-run</code></p></div></div></td><td><div><div><p>Preview the deploy-plane resources that would be undeployed without deleting anything</p></div></div></td><td><div><div><p><code>--dry-run</code></p></div></div></td></tr><tr><td><div><div><p><code>--environment &lt;value&gt;</code></p></div></div></td><td><div><div><p>Environment name<br>You can also set it with the <code>ANYPOINT_ENV</code> variable</p></div></div></td><td><div><div><p><code>--environment Sandbox</code></p></div></div></td></tr><tr><td><div><div><p><code>--gav &lt;value&gt;</code></p></div></div></td><td><div><div><p>Parent asset GAV (<code>groupId:assetId:version</code>). Discovers deployed resources remotely. Requires an environment to be selected</p></div></div></td><td><div><div><p><code>--gav myOrgId:my-network:0.0.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--host &lt;value&gt;</code></p></div></div></td><td><div><div><p>Host URL<br>Default: <code>anypoint.mulesoft.com</code><br>You can also set it with the <code>ANYPOINT_HOST</code> variable</p></div></div></td><td><div><div><p><code>--host mycompany.anypoint.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--json</code></p></div></div></td><td><div><div><p>Format output as JSON</p></div></div></td><td><div><div><p><code>--json</code></p></div></div></td></tr><tr><td><div><div><p><code>--organization &lt;value&gt;</code></p></div></div></td><td><div><div><p>Organization name<br>You can also set it with the <code>ANYPOINT_ORG</code> variable</p></div></div></td><td><div><div><p><code>--organization MyOrg</code></p></div></div></td></tr><tr><td><div><div><p><code>--password &lt;value&gt;</code></p></div></div></td><td><div><div><p>Password<br>You can also set it with the <code>ANYPOINT_PASSWORD</code> variable</p></div></div></td><td><div><div><p><code>--password myPassword</code></p></div></div></td></tr><tr><td><div><div><p><code>--path &lt;value&gt;</code></p></div></div></td><td><div><div><p>Path to the project. Discovers deployed resources remotely from the project lock file. Requires an environment to be selected. Mutually exclusive with <code>--gav</code></p></div></div></td><td><div><div><p><code>--path ./my-project</code></p></div></div></td></tr><tr><td><div><div><p><code>--process-timeout &lt;value&gt;</code></p></div></div></td><td><div><div><p>Process timeout in milliseconds<br>Default: <code>900000</code></p></div></div></td><td><div><div><p><code>--process-timeout 900000</code></p></div></div></td></tr><tr><td><div><div><p><code>--request-timeout &lt;value&gt;</code></p></div></div></td><td><div><div><p>Request timeout in milliseconds<br>Default: <code>60000</code></p></div></div></td><td><div><div><p><code>--request-timeout 60000</code></p></div></div></td></tr><tr><td><div><div><p><code>--username &lt;value&gt;</code></p></div></div></td><td><div><div><p>Username<br>You can also set it with the <code>ANYPOINT_USERNAME</code> variable</p></div></div></td><td><div><div><p><code>--username myuser@example.com</code></p></div></div></td></tr></tbody></table>

### Examples

Undeploy from the current project:

$ anypoint-cli-agent-fabric-plugin agent-network project undeploy --environment Sandbox

Undeploy from a specific project path:

$ anypoint-cli-agent-fabric-plugin agent-network project undeploy --path ./my-project --environment
Sandbox

Undeploy using GAV coordinates:

$ anypoint-cli-agent-fabric-plugin agent-network project undeploy --gav myOrgId:my-network:0.0.0
--environment Sandbox

Preview resources that would be undeployed (dry run):

$ anypoint-cli-agent-fabric-plugin agent-network project undeploy --dry-run --environment Sandbox

## agent-network:project:unpublish

\> anypoint-cli-agent-fabric-plugin agent-network project unpublish \[flags\]

Removes the agent network assets from Anypoint Exchange. By default performs a soft-delete; use
`--hard-delete` for irreversible removal.

To prevent orphaned runtime references to deleted Exchange assets, run
`agent-network project undeploy` before `unpublish`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--api-version &lt;value&gt;</code></p></div></div></td><td><div><div><p>API version used to discover remotely published assets when using <code>--gav</code><br>Default: <code>v1</code></p></div></div></td><td><div><div><p><code>--api-version v1</code></p></div></div></td></tr><tr><td><div><div><p><code>--bearer &lt;value&gt;</code></p></div></div></td><td><div><div><p>Bearer token<br>You can also set it with the <code>ANYPOINT_BEARER</code> variable</p></div></div></td><td><div><div><p><code>--bearer myBearerToken</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client ID<br>You can also set it with the <code>ANYPOINT_CLIENT_ID</code> variable</p></div></div></td><td><div><div><p><code>--client_id myClientID</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_secret &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client Secret<br>You can also set it with the <code>ANYPOINT_CLIENT_SECRET</code> variable</p></div></div></td><td><div><div><p><code>--client_secret myClientSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]collectMetrics</code></p></div></div></td><td><div><div><p>Collect metrics<br>You can also set it with the <code>COLLECT_METRICS</code> variable</p></div></div></td><td><div><div><p><code>--no-collectMetrics</code></p></div></div></td></tr><tr><td><div><div><p><code>--dry-run</code></p></div></div></td><td><div><div><p>Preview the Exchange assets that would be unpublished without deleting anything</p></div></div></td><td><div><div><p><code>--dry-run</code></p></div></div></td></tr><tr><td><div><div><p><code>--environment &lt;value&gt;</code></p></div></div></td><td><div><div><p>Environment name<br>You can also set it with the <code>ANYPOINT_ENV</code> variable</p></div></div></td><td><div><div><p><code>--environment Sandbox</code></p></div></div></td></tr><tr><td><div><div><p><code>--gav &lt;value&gt;</code></p></div></div></td><td><div><div><p>Parent asset GAV (<code>groupId:assetId:version</code>). Discovers assets remotely. Use <code>--environment</code> to enable the active API instances safety check</p></div></div></td><td><div><div><p><code>--gav myOrgId:my-network:0.0.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--hard-delete</code></p></div></div></td><td><div><div><p>Permanently delete assets from Exchange. This cannot be undone</p></div></div></td><td><div><div><p><code>--hard-delete</code></p></div></div></td></tr><tr><td><div><div><p><code>--host &lt;value&gt;</code></p></div></div></td><td><div><div><p>Host URL<br>Default: <code>anypoint.mulesoft.com</code><br>You can also set it with the <code>ANYPOINT_HOST</code> variable</p></div></div></td><td><div><div><p><code>--host mycompany.anypoint.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--json</code></p></div></div></td><td><div><div><p>Format output as JSON</p></div></div></td><td><div><div><p><code>--json</code></p></div></div></td></tr><tr><td><div><div><p><code>--organization &lt;value&gt;</code></p></div></div></td><td><div><div><p>Organization name<br>You can also set it with the <code>ANYPOINT_ORG</code> variable</p></div></div></td><td><div><div><p><code>--organization MyOrg</code></p></div></div></td></tr><tr><td><div><div><p><code>--password &lt;value&gt;</code></p></div></div></td><td><div><div><p>Password<br>You can also set it with the <code>ANYPOINT_PASSWORD</code> variable</p></div></div></td><td><div><div><p><code>--password myPassword</code></p></div></div></td></tr><tr><td><div><div><p><code>--path &lt;value&gt;</code></p></div></div></td><td><div><div><p>Path to the project. Reads the published assets from the project lock file. Select an environment to enable the active API instances safety check. Mutually exclusive with <code>--gav</code></p></div></div></td><td><div><div><p><code>--path ./my-project</code></p></div></div></td></tr><tr><td><div><div><p><code>--username &lt;value&gt;</code></p></div></div></td><td><div><div><p>Username<br>You can also set it with the <code>ANYPOINT_USERNAME</code> variable</p></div></div></td><td><div><div><p><code>--username myuser@example.com</code></p></div></div></td></tr></tbody></table>

### Examples

Unpublish with soft-delete:

$ anypoint-cli-agent-fabric-plugin agent-network project unpublish --environment Sandbox

Unpublish from a specific project path:

$ anypoint-cli-agent-fabric-plugin agent-network project unpublish --path ./my-project --environment
Sandbox

Unpublish with hard-delete (irreversible):

$ anypoint-cli-agent-fabric-plugin agent-network project unpublish --hard-delete --environment
Sandbox

Unpublish using GAV coordinates:

$ anypoint-cli-agent-fabric-plugin agent-network project unpublish --gav myOrgId:my-network:0.0.0
--environment Sandbox

Preview assets that would be unpublished (dry run):

$ anypoint-cli-agent-fabric-plugin agent-network project unpublish --dry-run --environment Sandbox

## agent-network:setup:gateways

\> anypoint-cli-agent-fabric-plugin agent-network setup gateways \[flags\]

Sets up the agent network environment with the required gateways in the specified target space
(private space, RTF, or shared space). This step is required only if the target space doesn’t
already have gateways. In the typical (happy path) workflow, you run it once per target space before
the first deployment.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-e, --egress-gw &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the egress gateway (separate-gateway mode; requires <code>--ingress-gw</code>)</p></div></div></td><td><div><div><p><code>--egress-gw my-egress</code></p></div></div></td></tr><tr><td><div><div><p><code>-g, --gateway &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the gateway for single-gateway mode (recommended). Mutually exclusive with <code>--ingress-gw</code> and <code>--egress-gw</code>.</p></div></div></td><td><div><div><p><code>--gateway my-gateway</code></p></div></div></td></tr><tr><td><div><div><p><code>-i, --ingress-gw &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the ingress gateway (separate-gateway mode)</p></div></div></td><td><div><div><p><code>--ingress-gw my-ingress</code></p></div></div></td></tr><tr><td><div><div><p><code>-t, --target-space &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the target space (private space, RTF, or shared space) where you set up the agent network environment<br>Default: <code>agent-network-space</code></p></div></div></td><td><div><div><p><code>--target-space my-space</code></p></div></div></td></tr><tr><td><div><div><p><code>--bearer &lt;value&gt;</code></p></div></div></td><td><div><div><p>Bearer token<br>You can also set it with the <code>ANYPOINT_BEARER</code> variable</p></div></div></td><td><div><div><p><code>--bearer myBearerToken</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_id &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client ID<br>You can also set it with the <code>ANYPOINT_CLIENT_ID</code> variable</p></div></div></td><td><div><div><p><code>--client_id myClientID</code></p></div></div></td></tr><tr><td><div><div><p><code>--client_secret &lt;value&gt;</code></p></div></div></td><td><div><div><p>Client Secret<br>You can also set it with the <code>ANYPOINT_CLIENT_SECRET</code> variable</p></div></div></td><td><div><div><p><code>--client_secret myClientSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]collectMetrics</code></p></div></div></td><td><div><div><p>Collect metrics<br>You can also set it with the <code>COLLECT_METRICS</code> variable</p></div></div></td><td><div><div><p><code>--no-collectMetrics</code></p></div></div></td></tr><tr><td><div><div><p><code>--dont-wait-for-gateways-running</code></p></div></div></td><td><div><div><p>Do not wait for the gateways to be running</p></div></div></td><td><div><div><p><code>--dont-wait-for-gateways-running</code></p></div></div></td></tr><tr><td><div><div><p><code>--environment &lt;value&gt;</code></p></div></div></td><td><div><div><p>Environment name<br>You can also set it with the <code>ANYPOINT_ENV</code> variable</p></div></div></td><td><div><div><p><code>--environment Sandbox</code></p></div></div></td></tr><tr><td><div><div><p><code>--host &lt;value&gt;</code></p></div></div></td><td><div><div><p>Host URL<br>Default: <code>anypoint.mulesoft.com</code><br>You can also set it with the <code>ANYPOINT_HOST</code> variable</p></div></div></td><td><div><div><p><code>--host mycompany.anypoint.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--organization &lt;value&gt;</code></p></div></div></td><td><div><div><p>Organization name<br>You can also set it with the <code>ANYPOINT_ORG</code> variable</p></div></div></td><td><div><div><p><code>--organization MyOrg</code></p></div></div></td></tr><tr><td><div><div><p><code>--password &lt;value&gt;</code></p></div></div></td><td><div><div><p>Password<br>You can also set it with the <code>ANYPOINT_PASSWORD</code> variable</p></div></div></td><td><div><div><p><code>--password myPassword</code></p></div></div></td></tr><tr><td><div><div><p><code>--username &lt;value&gt;</code></p></div></div></td><td><div><div><p>Username<br>You can also set it with the <code>ANYPOINT_USERNAME</code> variable</p></div></div></td><td><div><div><p><code>--username myuser@example.com</code></p></div></div></td></tr></tbody></table>

### Example

$ anypoint-cli-agent-fabric-plugin agent-network setup gateways --target-space my-space

<!-- document id=4a249483761c7acc5ff7bfd15abc8eaa83bad3e678b93b120e22a14eb6e9273c url=/mulesoft/current/en-us/anypoint-cli/3.x/datagraph.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Anypoint DataGraph

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

Anypoint CLI supports managing these DataGraph features:

- [DataGraph API Source Management](https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-source)

- [DataGraph Load Balancers](https://docs.mulesoft.com/anypoint-cli/3.x/datagraph-load-balancer)

<!-- document id=25892a8289e135f0c6e0b72447e13c5e6e9f25212483db3897eea852c7a3e4ba url=/mulesoft/current/en-us/anypoint-cli/3.x/account.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Anypoint Platform Accounts

> 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="#account-user-describe">account user describe</a></p></div></div></td><td><div><div><p>Show account details</p></div></div></td></tr><tr><td><div><div><p><a href="#account-business-group-list">account business-group list</a></p></div></div></td><td><div><div><p>Lists business groups</p></div></div></td></tr><tr><td><div><div><p><a href="#account-business-group-describe">account business-group describe</a></p></div></div></td><td><div><div><p>Show details of a business group</p></div></div></td></tr><tr><td><div><div><p><a href="#account-environment-list">account environment list</a></p></div></div></td><td><div><div><p>Lists environments</p></div></div></td></tr><tr><td><div><div><p><a href="#account-environment-create">account environment create</a></p></div></div></td><td><div><div><p>Create new environment</p></div></div></td></tr><tr><td><div><div><p><a href="#account-environment-delete">account environment delete</a></p></div></div></td><td><div><div><p>Delete an environment</p></div></div></td></tr><tr><td><div><div><p><a href="#account-environment-describe">account environment describe</a></p></div></div></td><td><div><div><p>Shows details of an environment</p></div></div></td></tr></tbody></table>

## account user describe

\> account user describe \[options\]

This command simply returns the information for your account. This includes your username, your full
name, your email address, and the creation date of your account.  
This command does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## account business-group list

\> account business-group list \[options\]

This command displays all [business groups](https://docs.mulesoft.com/access-management/business-groups). It returns the
name of the business group, the type ('Master' or 'Business unit'), and the ID.

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

## account business-group describe

\> account business-group describe \[options\] <identifier>

This command displays information on the business group you pass in `<identifier>`.  
If `<identifier>` is not specified, the command describes the business group on the current session.
Identifier searches for id match first, then name.

> [!NOTE] If your business group or organization name contains spaces, you need to enclose its name
> between `"` characters.
>
> > \> account business-group describe "QA Organization"

It returns data such as the owner, the type, subscription information, the entitlements of the group
and in which environment is running.

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

## account environment list

\> account environment list \[options\]

This command lists all your environments in Anypoint Platform. It returns your environment name, Id
and whether it’s sandboxed or not.  
This command does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## account environment create

\> account environment create \[options\] <name>

This command creates a new environment using the name you set in `<name>`.  
Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes
the `--type` option. Use the `--type` option to specify the environment type.  
Supported values for environment types are:

- `design`

- `production`

- `sandbox`

If no type is specified, the command creates a production environment.

## account environment delete

\> account environment delete \[options\] <name>

This command deletes the environment specified 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`.

## account environment describe

\> account environment describe \[options\] <name>

This command returns information about the environment specified in `<name>`  
If no `<name>` is provided, this command returns information about the current session’s
environment.

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

<!-- document id=1526a6e88873b41d1abb7e6e2a74ee38aa9c6b5cf53b02f973ec6cc61ed13070 url=/mulesoft/current/en-us/anypoint-cli/latest/account.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Anypoint Platform Accounts

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

Use the `account` commands to automate your Anypoint Plaform Account processes. For more information
about how to use these commands, refer to the
[Access Management documentation](https://docs.mulesoft.com/access-management/).

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#account-business-group-describe">account:business-group:describe</a></p></div></div></td><td><div><div><p>Show details of a business group</p></div></div></td></tr><tr><td><div><div><p><a href="#account-business-group-list">account:business-group:list</a></p></div></div></td><td><div><div><p>Lists business groups</p></div></div></td></tr><tr><td><div><div><p><a href="#account-environment-create">account:environment:create</a></p></div></div></td><td><div><div><p>Create new environment</p></div></div></td></tr><tr><td><div><div><p><a href="#account-environment-delete">account:environment:delete</a></p></div></div></td><td><div><div><p>Delete an environment</p></div></div></td></tr><tr><td><div><div><p><a href="#account-environment-describe">account:environment:describe</a></p></div></div></td><td><div><div><p>Shows details of an environment</p></div></div></td></tr><tr><td><div><div><p><a href="#account-environment-list">account:environment:list</a></p></div></div></td><td><div><div><p>Lists environments</p></div></div></td></tr><tr><td><div><div><p><a href="#account-user-describe">account:user:describe</a></p></div></div></td><td><div><div><p>Show account details</p></div></div></td></tr></tbody></table>

## account:business-group:describe

\> account:business-group:describe \[flags\] <identifier>

Displays information on the business group you pass in `<identifier>`  
If `<identifier>` is not specified, the command describes the business group on the current session.
Identifier searches for ID match first, then name.

> [!NOTE] If your business group or organization name contains spaces, enclose its name between `"`
> characters.
>
> > \> account:business-group:describe "QA Organization"

Returns the business group owner, type, subscription information, the entitlements of the group and
in which environment is running.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## account:business-group:list

\> account:business-group:list \[flags\]

Displays all [business groups](https://docs.mulesoft.com/access-management/business-groups). It returns the name of the
business group, the type ('Master' or 'Business unit'), and the ID.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## account:environment:create

\> account:environment:create \[flags\] <name>

Creates a new environment using the name you set in `<name>`  
Use the `--type` flag to specify the environment type.  
Supported values for environment types are:

- `design`

- `production`

- `sandbox`

If no type is specified, the command creates a sandbox environment.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## account:environment:delete

\> account:environment:delete \[flags\] <name>

Deletes the environment specified 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 the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## account:environment:describe

\> account:environment:describe \[flags\] <name>

Returns information about the environment specified in `<name>`  
If no `<name>` is provided, this command returns information about the current session’s
environment.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## account:environment:list

\> account:environment:list \[flags\]

Lists all your environments in Anypoint Platform. It returns your environment name, Id and whether
it’s sandboxed or not.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## account:user:describe

\> account:user:describe \[flags\]

Returns your account information, including your username, your full name, your email address, and
the creation date of your account.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=53698d1f6490ff2b050e6f40d66ef3d7d3bf86a107468cf68185715a5b1ab41f url=/mulesoft/current/en-us/anypoint-cli/3.x/runtime-fabric.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Anypoint Runtime Fabric

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

Anypoint CLI supports managing these Runtime Fabric features:

- [Runtime Fabric App Management](https://docs.mulesoft.com/anypoint-cli/3.x/runtime-fabric-apps)

- [Runtime Fabric Instances](https://docs.mulesoft.com/anypoint-cli/3.x/rtf-instances)

<!-- document id=ccfdd5ed4f8cca7ea4680939d00d9d960858595b7b6619a4a9e86178395174d1 url=/mulesoft/current/en-us/anypoint-cli/3.x/cloudhub-vpc.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Anypoint Virtual Private Cloud

> 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="#cloudhub-vpc-list">cloudhub vpc list</a></p></div></div></td><td><div><div><p>Lists all Anypoint VPCs</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-describe">cloudhub vpc describe</a></p></div></div></td><td><div><div><p>Show Anypoint VPC details</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-describe-json">cloudhub vpc describe-json</a></p></div></div></td><td><div><div><p>Show raw Anypoint VPC JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-create">cloudhub vpc create</a></p></div></div></td><td><div><div><p>Create a new Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-delete">cloudhub vpc delete</a></p></div></div></td><td><div><div><p>Delete an existing Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-environments-add">cloudhub vpc environments add</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments.</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-environments-remove">cloudhub vpc environments remove</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments.</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-business-groups-add">cloudhub vpc business-groups add</a></p></div></div></td><td><div><div><p>Share an Anypoint VPC with a list of Business Groups.</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-business-groups-remove">cloudhub vpc business-groups remove</a></p></div></div></td><td><div><div><p>Share an Anypoint VPC with a list of Business Groups.</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-dns-servers-set">cloudhub vpc dns-servers set</a></p></div></div></td><td><div><div><p>Sets the domain names that are resolved using your internal DNS servers. If used with no option, internal DNS will be disabled</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-dns-servers-unset">cloudhub vpc dns-servers unset</a></p></div></div></td><td><div><div><p>Clears the list domain names that are resolved using your internal DNS servers</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-firewall-rules-describe">cloudhub vpc firewall-rules describe</a></p></div></div></td><td><div><div><p>Show firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-firewall-rules-add">cloudhub vpc firewall-rules add</a></p></div></div></td><td><div><div><p>Add a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-firewall-rules-remove">cloudhub vpc firewall-rules remove</a></p></div></div></td><td><div><div><p>Remove a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr></tbody></table>

## cloudhub vpc list

\> cloudhub VPC list \[options\]

This command lists all available Anypoint VPCs. It returns ID, region, and environment of the
network and whether it is the default Anypoint VPC or not.

## cloudhub vpc describe

\> cloudhub vpc describe \[options\] <name>

This command displays information about the Anypoint VPC that is specified in `<name>`.

You can start typing your Anypoint VPC’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`.

## cloudhub vpc describe-json

\> cloudhub vpc describe \[options\] <name>

This command displays a raw JSON response of the Anypoint VPC that is specified in `<name>`.

You can start typing your Anypoint VPC’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`.

## cloudhub vpc create

\> cloudhub vpc create \[options\] <name> <region> <cidrBlock> \[environments...\]

This command creates an Anypoint VPC using the name in `<name>`, in the region specified in
`<region>`, with the [size](https://docs.mulesoft.com/cloudhub/vpc-provisioning-concept#faq_how_to_size_vpc) passed in
`<cidrBlock>` in the form of a Classless Inter-Domain Routing (CIDR) block, using
[CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks) and
associates it to the [environments](https://docs.mulesoft.com/access-management/environments) passed as argument(s)
thereafter.

> [!NOTE] An Anypoint VPC needs to be bound to a business group within your organization. When
> creating an Anypoint VPC, make sure to assign it a business group using the
> [business-groups add](#cloudhub-vpc-business-groups-add) command.

Besides the default `--help` option, this command also takes the `--default` option. When passed,
the Anypoint VPC is created as the default Anypoint VPC for the selected environment.

## cloudhub vpc delete

\> cloudhub vpc delete <name>

This command deletes the Anypoint VPC specified 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`.

## cloudhub vpc environments add

\> cloudhub vpc environments add \[options\] <vpc> \[environments...\]

This command assigns the Anypoint VPC defined in `<vpc>` to the environment(s) passed as argument(s)
thereafter.  
The `--default` option allows setting an Anypoint VPC as the default for the organization, which
applies to all environments which don’t have an Anypoint VPC explicitly associated.

This command also takes the default `--help` option.

## cloudhub vpc environments remove

\> cloudhub vpc environments remove \[options\] <vpc> \[environments...\]

This command removes the Anypoint VPC defined in `<vpc>` from the environment(s) passed as
argument(s) thereafter.  
Besides the default `--help` option, this command also takes the option `--default`, that removes
this Anypoint VPC as the default Anypoint VPC for the environment.

## cloudhub vpc business-groups add

\> cloudhub vpc business-groups add \[options\] <vpc> <businessGroups...>

This command assigns the Anypoint VPC defined in `<vpc>` to the business group(s) passed as
argument(s) thereafter.

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

## cloudhub vpc business-groups remove

\> cloudhub vpc business-groups remove \[options\] <vpc> <businessGroups...>

This command removes the Anypoint VPC defined in `<vpc>` from the business group(s) passed as
argument(s) thereafter

> [!WARNING] This command does not prompt twice before removing the Anypoint VPC from the specified
> resource. If you send a remove instruction, it does not ask for confirmation.

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

## cloudhub vpc dns-servers set

\> cloudhub vpc dns-servers set \[options\] <vpc>

This command sets a list of local host names (internal domain names) to be resolved using your DNS
servers for which you need to provide their IP addresses (whether private or public addresses).  
Whenever those private domains are provided, your worker resolves them using your private DNS, so
you can still use the internal host names of your private network.

> [!NOTE] This feature is supported by workers running Mule versions 3.5.x, 3.6.x, 3.7.4, 3.8.0-HF1,
> 3.8.1 and 3.8.2.

Besides 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><code>server</code></p></div></div></td><td><div><div><p>IP address for a DNS server to resolve special domains on. Can be specified up to 3 times</p></div></div></td></tr><tr><td><div><div><p><code>domain</code></p></div></div></td><td><div><div><p>A domain to resolve on the special DNS server list. Can be specified multiple times</p></div></div></td></tr></tbody></table>

You can pass as many domains as you need, and up to 3 IP addresses.  
For example, `$ cloudhub vpc dns-servers set --domain example.com --server 192.168.1.10 <VPC Name>`.

Every time you run this command, you overwrite your previous DNS set command.  
To remove a DNS set, you need to use the [vpc dns-servers unset](#cloudhub-vpc-dns-servers-unset)
command.

## cloudhub vpc dns-servers unset

\> cloudhub vpc dns-servers unset \[options\] <vpc>

This command clears the list of local host names (internal domain names) to be resolved using your
DNS servers from the Anypoint VPC passed in `<vpc>`.

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

## cloudhub vpc firewall-rules describe

\> cloudhub vpc firewall-rules describe <vpc>

This command describes all the firewall rules for the Anypoint VPC defined in `<vpc>`.

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

## cloudhub vpc firewall-rules add

\> cloudhub vpc firewall-rules add \[options\] <vpc> <cidrBlock> <protocol> <fromPort> \[toPort\]

This command adds a firewall rule to the Anypoint VPC defined in `<vpc>` using the values set in the
variables:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>vpc</code></p></div></div></td><td><div><div><p>Name of the Anypoint VPC to which this load balancer is bound.<br>If your Anypoint VPC name contains spaces, you need to pass it between ´"´ characters</p></div></div></td><td><div><div><p>vpc-demo</p></div></div></td></tr><tr><td><div><div><p><code>cidrBlock</code></p></div></div></td><td><div><div><p>IP address in CIDR notation for the firewall to allow</p></div></div></td><td><div><div><p>192.0.1.0/27</p></div></div></td></tr><tr><td><div><div><p><code>protocol</code></p></div></div></td><td><div><div><p>The protocol to use in the rules. It can be <code>tcp</code> or <code>udp</code></p></div></div></td><td><div><div><p>tcp</p></div></div></td></tr><tr><td><div><div><p><code>fromPort</code></p></div></div></td><td><div><div><p>The port from which the firewall will allow requests. It can go from 0 to 65535</p></div></div></td><td><div><div><p>8888</p></div></div></td></tr><tr><td><div><div><p><code>toPort</code></p></div></div></td><td><div><div><p><strong>optional</strong> In case a port range is needed, the <code>fromPort</code> and <code>toPort</code> variables define such range</p></div></div></td><td><div><div><p>8090</p></div></div></td></tr></tbody></table>

> [!CAUTION] When creating an Anypoint VPC, make sure to allow your outbound address.  
> By default, all IP addresses are blocked, and you need to authorize IP addresses or range of
> addresses to your Anypoint VPC firewall rule.

You can start typing your Anypoint VPC’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`.

## cloudhub vpc firewall-rules remove

\> cloudhub vpc firewall-rules remove <vpc> <index>

This command removes the firewall rule from the workers inside the Anypoint VPC specified in `<vpc>`
at the index passed in the `<index>`.

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

<!-- document id=9f7bf3f0bd1c7cbdf743967c2b6c41bbeb4d179194e75f39e2aced9f334f2d3d url=/mulesoft/current/en-us/anypoint-cli/latest/cloudhub-vpc.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Anypoint Virtual Private Cloud

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

Use the `cloudhub-vpc` commands to automate your Anypoint Virtual Private CLoud processes. For more
information about how to use these commands, refer to the [CloudHub documentation](https://docs.mulesoft.com/cloudhub/).

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#cloudhub-vpc-business-groups-add">cloudhub:vpc:business-groups:add</a></p></div></div></td><td><div><div><p>Shares an Anypoint VPC with a list of Business Groups</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-business-groups-remove">cloudhub:vpc:business-groups:remove</a></p></div></div></td><td><div><div><p>Shares an Anypoint VPC with a list of Business Groups</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-create">cloudhub:vpc:create</a></p></div></div></td><td><div><div><p>Creates a new Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-delete">cloudhub:vpc:delete</a></p></div></div></td><td><div><div><p>Deletes an existing Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-describe">cloudhub:vpc:describe</a></p></div></div></td><td><div><div><p>Show Anypoint VPC details</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-dns-servers-set">cloudhub:vpc:dns-servers:set</a></p></div></div></td><td><div><div><p>Sets the domain names that are resolved using your internal DNS servers</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-dns-servers-unset">cloudhub:vpc:dns-servers:unset</a></p></div></div></td><td><div><div><p>Clears the list domain names that are resolved using your internal DNS servers</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-environments-add">cloudhub:vpc:environments:add</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-environments-remove">cloudhub:vpc:environments:remove</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-firewall-rules-add">cloudhub:vpc:firewall-rules:add</a></p></div></div></td><td><div><div><p>Adds a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-firewall-rules-describe">cloudhub:vpc:firewall-rules:describe</a></p></div></div></td><td><div><div><p>Shows firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-firewall-rules-remove">cloudhub:vpc:firewall-rules:remove</a></p></div></div></td><td><div><div><p>Removes a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-vpc-list">cloudhub:vpc:list</a></p></div></div></td><td><div><div><p>Lists all Anypoint VPCs</p></div></div></td></tr></tbody></table>

## cloudhub:vpc:business-groups:add

\> cloudhub:vpc:business-groups:add \[flags\] <vpc> <businessGroups...>

Assigns the Anypoint VPC defined in `<vpc>` to the business group(s) passed as argument(s)
thereafter

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:business-groups:remove

\> cloudhub:vpc:business-groups:remove \[flags\] <vpc> <businessGroups...>

Removes the Anypoint VPC defined in `<vpc>` from the business group(s) passed as argument(s)
thereafter

> [!WARNING] This command does not prompt twice before removing the Anypoint VPC from the specified
> resource. If you send a remove instruction, it does not ask for confirmation.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:create

\> cloudhub:vpc:create \[flags\] <name> <region> <cidrBlock> \[environments...\]

Creates an Anypoint VPC using the name in `<name>`, in the region specified in `<region>`, with the
[size](https://docs.mulesoft.com/cloudhub/vpc-provisioning-concept#faq_how_to_size_vpc) passed in `<cidrBlock>` in the
form of a Classless Inter-Domain Routing (CIDR) block, using
[CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks) and
associates it to the [environments](https://docs.mulesoft.com/access-management/environments) passed as argument(s)
thereafter.

> [!NOTE] An Anypoint VPC needs to be bound to a business group within your organization. When
> creating an Anypoint VPC, make sure to assign it a business group using the
> [business-groups add](#cloudhub-vpc-business-groups-add) command.

This command accepts the `--default` flag. When passed, the Anypoint VPC is created as the default
Anypoint VPC for the selected environment.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:delete

\> cloudhub:vpc:delete <name>

Deletes the Anypoint VPC specified 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 the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:describe

\> cloudhub:vpc:describe \[flags\] <name>

Displays information about the Anypoint VPC that is specified in `<name>`

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:dns-servers:set

\> cloudhub:vpc:dns-servers:set \[flags\] <vpc>

Sets a list of local host names (internal domain names) to be resolved using your DNS servers for
which you need to provide their IP addresses (whether private or public addresses).  
Whenever those private domains are provided, your worker resolves them using your private DNS, so
you can still use the internal host names of your private network.

> [!NOTE] This feature is supported by workers running Mule versions 3.5.x, 3.6.x, 3.7.4, 3.8.0-HF1,
> 3.8.1 and 3.8.2.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--domain</code></p></div></div></td><td><div><div><p>A domain to resolve on the special DNS server list<br>Can be specified multiple times</p></div></div></td><td><div><div><p><code>--domain example.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--server</code></p></div></div></td><td><div><div><p>IP address for a DNS server to resolve special domains on<br>Can be specified up to 3 times</p></div></div></td><td><div><div><p><code>--server 192.168.1.10</code></p></div></div></td></tr></tbody></table>

Every time you run this command, you overwrite your previous DNS set command.  
To remove a DNS set, you need to use the [vpc dns-servers unset](#cloudhub-vpc-dns-servers-unset)
command.

## cloudhub:vpc:dns-servers:unset

\> cloudhub:vpc:dns-servers:unset \[flags\] <vpc>

Clears the list of local host names (internal domain names) to be resolved using your DNS servers
from the Anypoint VPC passed in `<vpc>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:environments:add

\> cloudhub:vpc:environments:add \[flags\] <vpc> \[environments...\]

Assigns the Anypoint VPC defined in `<vpc>` to the environment(s) passed as argument(s) thereafter
The `--default` flag allows setting an Anypoint VPC as the default for the organization, which
applies to all environments which don’t have an Anypoint VPC explicitly associated.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:environments:remove

\> cloudhub:vpc:environments:remove \[flag\] <vpc> \[environments...\]

Removes the Anypoint VPC defined in `<vpc>` from the environment(s) passed as argument(s) thereafter

This command accepts the `--default` flag, that removes this Anypoint VPC as the default Anypoint
VPC for the environment.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:firewall-rules:add

\> cloudhub:vpc:firewall-rules:add \[flags\] <vpc> <cidrBlock> <protocol> <fromPort> \[toPort\]

Adds a firewall rule to the Anypoint VPC defined in `<vpc>` using the values set in the variables:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>vpc</code></p></div></div></td><td><div><div><p>Name of the Anypoint VPC to which this load balancer is bound<br>If your Anypoint VPC name contains spaces, you need to pass it between ´"´ characters</p></div></div></td><td><div><div><p><code>vpc-demo</code></p></div></div></td></tr><tr><td><div><div><p><code>cidrBlock</code></p></div></div></td><td><div><div><p>IP address in CIDR notation for the firewall to allow</p></div></div></td><td><div><div><p><code>192.0.1.0/27</code></p></div></div></td></tr><tr><td><div><div><p><code>protocol</code></p></div></div></td><td><div><div><p>The protocol to use in the rules. It can be <code>tcp</code> or <code>udp</code></p></div></div></td><td><div><div><p><code>tcp</code></p></div></div></td></tr><tr><td><div><div><p><code>fromPort</code></p></div></div></td><td><div><div><p>The port from which the firewall will allow requests. It can go from 0 to 65535</p></div></div></td><td><div><div><p><code>8888</code></p></div></div></td></tr><tr><td><div><div><p><code>toPort</code></p></div></div></td><td><div><div><p><strong>optional</strong> In case a port range is needed, the <code>fromPort</code> and <code>toPort</code> variables define such range</p></div></div></td><td><div><div><p><code>8090</code></p></div></div></td></tr></tbody></table>

> [!CAUTION] When creating an Anypoint VPC, make sure to allow your outbound address.  
> By default, all IP addresses are blocked, and you need to authorize IP addresses or range of
> addresses to your Anypoint VPC firewall rule.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:firewall-rules:describe

\> cloudhub:vpc:firewall-rules:describe <vpc>

Describes all the firewall rules for the Anypoint VPC defined in `<vpc>`

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:firewall-rules:remove

\> cloudhub:vpc:firewall-rules:remove <vpc> <index>

Removes the firewall rule from the workers inside the Anypoint VPC specified in `<vpc>` at the index
passed in the `<index>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:vpc:list

\> cloudhub:vpc:list \[flags\]

Lists all available Anypoint VPCs  
It returns ID, region, and environment of the network and whether it is the default Anypoint VPC or
not.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=7b6cea40aba8ac7f7d8a5c315241c81e898f4708d14249d1a72750dff9654faf url=/mulesoft/current/en-us/anypoint-cli/3.x/api-governance.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for API Governance

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

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Command</p></td><td><p>Description</p></td></tr><tr><td><p><a href="#governance-api-evaluate">governance api evaluate</a></p></td><td><p>Evaluates filter criteria to determine which rulesets apply to APIs that meet that criteria</p></td></tr><tr><td><p><a href="#governance-api-inspect">governance api inspect</a></p></td><td><p>Inspects an API definition and lists its schemas</p></td></tr><tr><td><p><a href="#governance-api-validate">governance api validate</a></p></td><td><p>Validates an API definition against a specified governance ruleset</p></td></tr><tr><td><p><a href="#governance-document">governance document</a></p></td><td><p>Creates the documentation file for a governance ruleset definition</p></td></tr><tr><td><p><a href="#governance-profile-create">governance profile create</a></p></td><td><p>Creates a governance profile</p></td></tr><tr><td><p><a href="#governance-profile-delete">governance profile delete</a></p></td><td><p>Deletes a governance profile</p></td></tr><tr><td><p><a href="#governance-profile-info">governance profile info</a></p></td><td><p>Lists information for a specific governance profile ID</p></td></tr><tr><td><p><a href="#governance-profile-list">governance profile list</a></p></td><td><p>Lists all governance profiles for an organization</p></td></tr><tr><td><p><a href="#governance-profile-update">governance profile update</a></p></td><td><p>Updates a governance profile</p></td></tr><tr><td><p><a href="#governance-ruleset-clone">governance ruleset clone</a></p></td><td><p>Clones a governance ruleset and applies specified updates to rules</p></td></tr><tr><td><p><a href="#governance-ruleset-info">governance ruleset info</a></p></td><td><p>Lists ruleset rules</p></td></tr><tr><td><p><a href="#governance-ruleset-init">governance ruleset init</a></p></td><td><p>Initializes a governance ruleset definition based on a data schema</p></td></tr><tr><td><p><a href="#governance-ruleset-validate">governance ruleset validate</a></p></td><td><p>Validates a governance ruleset definition’s format</p></td></tr></tbody></table>

## governance api evaluate

`> governance api evaluate [options]`

This command evaluates specified filters to determine the rulesets that would be applied to your
APIs that meet that criteria.

Besides the default options `--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>--api=&lt;api&gt;</p></div></div></td><td><div><div><p>The API project against which you want to evaluate. The command uses the criteria in the project’s <code>exchange.json</code> file.</p></div></div></td></tr><tr><td><div><div><p>--criteria &lt;filtertype:filtervalue&gt;,…​</p></div></div></td><td><div><div><p>Enables you to apply filters against which to evaluate to identify rulesets. Specify a list of comma-separated filters where each filter has a type and value, in the format <code>filtertype:filtervalue</code>.</p></div><div><p>Available filters include:</p></div><div><ul><li><p><code>scope</code>: API type, <code>rest-api</code> or <code>async-api</code></p></li><li><p><code>tag</code>: Tag defined for APIs in Exchange</p></li><li><p><code>category</code>: Category defined for APIs in Exchange, where the filter value is specified in two parts as <code>categoryName:value</code></p></li><li><p><code>status</code>: Lifecycle state of stable, development, or deprecated</p></li><li><p><code>env-type</code>: Environment type of any, production, or sandbox</p></li><li><p><code>env-id</code>: The ID for the environment name in API Manager. You can get this value using <strong>API Manager</strong> &gt; <strong>Environment information</strong>. See <a href="https://docs.mulesoft.com/api-manager/latest/environments-concept">Reviewing Environment Concepts</a>.</p><div><p>If <code>env-type</code> or <code>env-id</code> is used, the <strong>API Instance</strong> filter is set in the profile, so that only APIs that have instances are filtered. APIs in the development lifecycle cannot have instances.</p></div><div><p>To deselect the <strong>API Instance</strong> filter in the profile using the CLI, update the profile using the <code>--criteria</code> flag with neither <code>env-type</code> nor <code>env-id</code>.</p></div></li></ul></div><div><p>Example: tag:tag1,category:category1:value,category:category2:value2,status:stable,status:development,status:deprecated,scope:rest-api,scope:async-api,env-type:production</p></div></div></td></tr></tbody></table>

> [!NOTE] This command must be run with either the `criteria` or the `api` option.

**Example commands:**

```copy
anypoint-cli governance api evaluate --criteria `tag:best,category:API Type:Experience API,scope:rest-api`

anypoint-cli governance api evaluate --api ~/Downloads/order-api-1.0.0-raml.zip
```

**Example output:**

Ruleset GAV 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0
8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0
68ef9520-24e9-4cf2-b2f5-620025690913/required-examples/1.0.0

## governance api inspect

`> governance api inspect [options] <api-definition>`

This command inspects the API definition passed in `api-definition` and lists all its schemas, such
as headers, requests, and response payloads. You can use this schema information in the
`governance ruleset init` command. See [governance ruleset init](#governance-ruleset-init).

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

**Example command:**

```copy
anypoint-cli governance api inspect my-healthcare-api.yaml
```

**Example schema**

```copy
types:
  patientmultipleBirthBoolean:
    properties:
      multipleBirthBoolean:
        description: Whether patient is part of a multiple birth
        type: boolean
  patientmultipleBirthInteger:
    properties:
      multipleBirthInteger:
        description: Whether patient is part of a multiple birth
        type: integer

        .
        .
        .

  PatientEntry:
    type: FHIR_commons.Entry
    properties:
      resource: Patient

  PatientBundle:
    type: FHIR_commons.Bundle
    properties:
      entry?: PatientEntry[]
```

**Example output:**

'patientmultipleBirthBoolean', 'PatientBundle', 'patientmultipleBirthInteger', 'PatientEntry'

## governance api validate

`> governance api validate [options] <api-definition>`

This command validates the API definition passed in `api-definition` against specified rulesets.

You can specify `api-definition` as one of the following:

- An API project ZIP file

- An API project folder

- An asset identifier for an API project, if the `--remote` option is specified. An asset identifier
  is a group ID, asset ID, and version (GAV) that uniquely identifies each asset in Exchange.

You can specify rulesets against which to validate as follows:

- To use an existing `exchange.json` file that defines your API project’s ruleset dependencies,
  ensure that it is included in the folder or ZIP file that you specify in `api-definition`. If the
  `exchange.json` file is present, the command downloads all dependencies and validates against the
  rulesets in the project.

- To validate directly against rulesets published in Exchange, use the `--remote-rulesets` option.

- To validate against local rulesets, use the `--rulesets` option.

> [!NOTE] Duplicate rulesets are not detected, so if you use more than one of the preceding ways of
> identifying rulesets in the same command execution, some rulesets may be validated multiple times.

Besides the default options `--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>--rulesets &lt;ruleset-yaml-file1&gt;,&lt;ruleset-yaml-file2&gt;,…​</p></div></div></td><td><div><div><p>Local ruleset definitions. The <code>rulesets</code> option is followed by a comma-separated list of ruleset YAML files.</p></div></div></td></tr><tr><td><div><div><p>--remote-rulesets &lt;ruleset-asset-identifier&gt;,&lt;ruleset-asset-identifier&gt;,…​</p></div></div></td><td><div><div><p>Remote ruleset definitions. The <code>remote-rulesets</code> option is followed by a comma-separated list of ruleset asset identifiers. An asset identifier is a group ID, asset ID, and version (GAV) that uniquely identifies each asset in Exchange. For example: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;,&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code></p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers (GAVs)</a>.</p></div></div></td></tr><tr><td><div><div><p>--remote</p></div></div></td><td><div><div><p>Flag to indicate that the validation should be done against a published API. The value passed in <code>api-definition</code> is the API’s asset identifier. An asset identifier is a group ID, asset ID, and version (GAV) that uniquely identifies each asset in Exchange. For example: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code></p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers (GAVs)</a>.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli governance api validate ~/Downloads/order-api-1.0.0-raml.zip

anypoint-cli governance api validate ~/Downloads/order-api-1.0.0-raml

anypoint-cli governance api validate --rulesets /MyRulesets/ruleset1.yaml,/MyRulesets/ruleset2.yaml  ~/Downloads/order-api-1.0.0-raml.zip

anypoint-cli governance api validate --remote-rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1  ~/Downloads/order-api-1.0.0-raml.zip

anypoint-cli governance api validate --remote-rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --remote 8a840abd-e63a-4f8b-87ab-24052eda2017/order-api/1.0.0
```

**Example output:**

For a definition that is conformant to the ruleset:

Spec conforms with Ruleset

For a definition that is nonconformant to the ruleset:

Conforms: false Number of results: 3 **(1)**

Functional Validations
----------------------

Constraint: http://a.ml/vocabularies/amf/core#declaration-not-found Severity: Violation Message: not
supported scalar for documentation Target: null Range: \[(6,3)-(6,3)\] Location:
file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml

Conformance Validations **(2)**
-----------------------

Constraint:
file:///exchange\_modules/68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0/ruleset.yaml#/encodes/validations/api-must-have-documentation
**(3)** Severity: Warning **(4)** Message: Provide the documentation for the API. **(5)** Target:
amf://id#2 **(6)** Range: \[(2,0)-(6,4)\] **(7)** Location:
file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml **(8)**

Constraint:
file:///exchange\_modules/8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0/bestpractices.yaml#/encodes/validations/api-must-have-documentation
Severity: Violation Message: Provide the documentation for the API Target: amf://id#2 Range:
\[(2,0)-(6,4)\] Location: file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Total of functional and conformance validation issues found</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Conformance issues section</td></tr><tr><td><i data-value="3"></i><b>3</b></td><td>Ruleset and rule to which this set of issues applies</td></tr><tr><td><i data-value="4"></i><b>4</b></td><td>Severity level for the issue</td></tr><tr><td><i data-value="5"></i><b>5</b></td><td>Description of the issue</td></tr><tr><td><i data-value="6"></i><b>6</b></td><td>AMF model node ID; for information on the AMF model, see <a href="https://docs.mulesoft.com/api-governance/create-custom-rulesets">Creating Custom Governance Rulesets</a></td></tr><tr><td><i data-value="7"></i><b>7</b></td><td>Beginning line number and column and end line number and column in the API definition where the issue occurs, where column is the offset from the beginning of the line and numbering for the offset starts at 0</td></tr><tr><td><i data-value="8"></i><b>8</b></td><td>The file in which the issue occurs, either the main file or one of its dependencies</td></tr></tbody></table>

## governance document

`> governance document [options] <ruleset> <doc-file>`

This command creates the documentation for the API Governance ruleset definition ZIP file specified
in `ruleset`. It puts the documentation in the `doc-file` ZIP file for you to upload and publish to
Exchange.

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

**Example command:**

```copy
anypoint-cli governance document ~/temp/ruleset.yaml ~/temp/ruleset.doc.zip
```

**Example output:**

validation name \[ 'scalar-parameters' \] Saving to /Users/janedoe/temp/prof-1.doc.zip

## governance profile create

`> governance profile create [options] <profile-name> <ruleset-asset-identifiers>`

This command creates a governance profile using a string value for the new governance profile name
specified in `profile-name`.

You must include `ruleset-asset-identifiers`, a comma-separated list of ruleset asset identifiers,
each of which is the group ID, asset ID, and version (GAV) that uniquely identifies each asset in
Exchange. For example: `<group_id>/<asset_id>/<version>,<group_id>/<asset_id>/<version>`, where
`<version>` is a specific version or `latest`. If you use `latest` as the version, the profile
automatically uses the latest version of the ruleset when versions are published after you create
the profile.

You can use one of the `notify` options to configure notifications for the profile you are creating.
If you do not use a `notify` option, no notifications are configured by the command. Notifications
are off by default.

See [Get Exchange Asset Identifiers (GAVs)](#exchange-asset-identifiers).

Besides the default options `--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>--criteria &lt;filtertype:filtervalue&gt;,…​</p></div></div></td><td><div><div><p>Enables you to apply filters to select the list of APIs to which the profile rulesets will apply. Specify a list of comma-separated filters where each filter has a type and value in the format <code>filtertype:filtervalue</code>.</p></div><div><p>Available filters include:</p></div><div><ul><li><p><code>scope</code>: API type, <code>rest-api</code> or <code>async-api</code></p></li><li><p><code>tag</code>: Tag defined for APIs in Exchange</p></li><li><p><code>category</code>: Category defined for APIs in Exchange, where the filter value is specified in two parts as <code>categoryName:value</code></p></li><li><p><code>status</code>: Lifecycle state of stable, development, or deprecated</p></li><li><p><code>env-type</code>: Environment type of any, production, or sandbox</p></li><li><p><code>env-id</code>: The ID for the environment name in API Manager. You can get this value using <strong>API Manager</strong> &gt; <strong>Environment information</strong>. See <a href="https://docs.mulesoft.com/api-manager/latest/environments-concept">Reviewing Environment Concepts</a>.</p><div><p>If <code>env-type</code> or <code>env-id</code> is used, the <strong>API Instance</strong> filter is set in the profile, so that only APIs that have instances are filtered. APIs in the development lifecycle cannot have instances.</p></div><div><p>To deselect the <strong>API Instance</strong> filter in the profile using the CLI, update the profile using the <code>--criteria</code> flag with neither <code>env-type</code> nor <code>env-id</code>.</p></div></li></ul></div><div><p>Example: tag:tag1,category:category1:value,category:category2:value2,status:stable,status:development,status:deprecated,scope:rest-api,scope:async-api,env-type:production</p></div></div></td></tr><tr><td><div><div><p>--tags &lt;tags&gt; <strong>Deprecated</strong></p></div></div></td><td><div><div><p><strong>The <code>--criteria</code> option replaces the <code>tags</code> option starting with Anypoint CLI version v3.17.0.</strong> In versions prior to v3.17.0, the <code>tags</code> option is followed by a comma separated list of tags to be applied to the new governance profile, formatted as follows: <code>tag1,tag2,tag3</code></p></div></div></td></tr><tr><td><div><div><p>--description &lt;description&gt;</p></div></div></td><td><div><div><p>The <code>description</code> option is followed by a string that is the new governance profile’s description.</p></div></div></td></tr><tr><td><div><div><p>--notify-contact</p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the contact set for the API.</p></div></div></td></tr><tr><td><div><div><p>--notify-publisher</p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the API publisher.</p></div></div></td></tr><tr><td><div><div><p>--notify-others &lt;email ID,email ID,…​&gt;</p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the specified list of email IDs.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli governance profile create "Open API Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --criteria "tag:oas,category:API Type:Experience API,status:development,scope:rest-api" --description "Profile for OAS Best Practices"

anypoint-cli governance profile create "Anypoint Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-api-best-practices/1.0.1 --criteria "tag:raml tag:oas category:API Type:Experience API,status:stable,scope:rest-api" --description "Profile for REST API Best Practices" --notify-publisher  --notify-contact --notify-others a@a.a,b@b.com

anypoint-cli governance profile create "Primary API Standards" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/1.0.2 --criteria "tag:prim,category:API Type:Experience API,status:stable,scope:rest-api,env-id:0683ce02-cd53-4028-a543-832a38a8af30" --description "Profile for Primary API Standards"
```

**Example output:**

Profile Added Id 4f98e59d-8efb-420f-ac95-9cd0af15bd45 Name OAS Best Practices Description Profile
for OAS Best Practices Rulesets
gav://68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 Filter tag:best

## governance profile delete

`> governance profile delete [options] <profile-id>`

This command deletes a specific governance profile specified by `profile-id`. To get this ID, run
the `governance profile info` or `governance profile list` command.

The `governance profile delete` command accepts only the default options: `--help`, `-f`/`--fields`
and `-o`/`--output`.

**Example command:**

```copy
anypoint-cli governance profile delete 8ffd463f-86b2-4132-afc6-44d179209362
```

**Example output:**

Profile with id 8ffd463f-86b2-4132-afc6-44d179209362 removed

## governance profile info

`> governance profile info [options] <profile-id>`

This command lists all information for a governance profile ID.

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

**Example command:**

```copy
anypoint-cli governance profile info 19fb211b-8775-43cc-865a-46228921d6ed --output text
```

**Example output:**

Id 19fb211b-8775-43cc-865a-46228921d6ed Name Best Practices Description Best Practices Profile
Rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0
8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0
68ef9520-24e9-4cf2-b2f5-620025690913/required-examples/1.0.0 Criteria tag:best,category:API
Type:Experience API,scope:rest-api NotificationConfig Contact,Publisher

## governance profile list

`> governance profile list [options]`

This command lists information for all governance profiles for an organization. You need this
information when updating a governance profile.

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

**Example command:**

```copy
anypoint-cli governance profile list -o text
```

**Example output:**

Profile Name Profile Id

Minimum Security Requirements 1f418cf4-b870-4b31-8734-f55f28d45f8f Best Practices
19fb211b-8775-43cc-865a-46228921d6ed New Best Practices 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 OAS
Standards 51ae8795-2278-407e-942f-becba29af986

## governance profile update

`> governance profile update [options] <profile-id>`

This command updates the governance profile specified in `profile-id`. To get this ID, run the
`governance profile info` or `governance profile list` command.

You can update the governance profile’s general information, rulesets, filter criteria, and
notification configuration. You can use one of the `notify` options to update the notification
configuration or turn off notifications. Any changes override existing notification configurations.
If you do not use a `notify` option, no changes are made to the notification configuration.

Besides the default options `--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>--profile-name &lt;profile-name&gt;</p></div></div></td><td><div><div><p>The <code>profile-name</code> option is followed by a string that is the new governance profile name.</p></div></div></td></tr><tr><td><div><div><p>--ruleset-gavs &lt;ruleset-gavs&gt;</p></div></div></td><td><div><div><p>The <code>ruleset-gavs</code> option is a list with the asset identifier for each ruleset, formatted as follows: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;,&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code>, where <code>&lt;version&gt;</code> is a specific version or <code>latest</code>. An asset identifier is a unique group ID, asset ID, and version (GAV) that identifies each asset in Exchange. If you use <code>latest</code> as the version, the profile automatically uses the latest version of the ruleset when versions are published after you create the profile.</p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers (GAVs)</a>.</p></div></div></td></tr><tr><td><div><div><p>--criteria &lt;filtertype:filtervalue&gt;,…​</p></div></div></td><td><div><div><p>Enables you to apply filters to select the list of APIs to which the profile rulesets will apply. Specify a list of comma-separated filters where each filter has a type and value in the format <code>filtertype:filtervalue</code>.</p></div><div><p>Available filters include:</p></div><div><ul><li><p><code>scope</code>: API type, <code>rest-api</code> or <code>async-api</code></p></li><li><p><code>tag</code>: Tag defined for APIs in Exchange</p></li><li><p><code>category</code>: Category defined for APIs in Exchange, where the filter value is specified in two parts as <code>categoryName:value</code></p></li><li><p><code>status</code>: Lifecycle state of stable, development, or deprecated</p></li><li><p><code>env-type</code>: Environment type of any, production, or sandbox</p></li><li><p><code>env-id</code>: The ID for the environment name in API Manager. You can get this value using <strong>API Manager</strong> &gt; <strong>Environment information</strong>. See <a href="https://docs.mulesoft.com/api-manager/latest/environments-concept">Reviewing Environment Concepts</a>.</p><div><p>If <code>env-type</code> or <code>env-id</code> is used, the <strong>API Instance</strong> filter is set in the profile, so that only APIs that have instances are filtered. APIs in the development lifecycle cannot have instances.</p></div><div><p>To deselect the <strong>API Instance</strong> filter in the profile using the CLI, update the profile using the <code>--criteria</code> flag with neither <code>env-type</code> nor <code>env-id</code>.</p></div></li></ul></div><div><p>Example: tag:tag1,category:category1:value,category:category2:value2,status:stable,status:development,status:deprecated,scope:rest-api,scope:async-api,env-type:production</p></div></div></td></tr><tr><td><div><div><p>--tags &lt;tags&gt; <strong>Deprecated</strong></p></div></div></td><td><div><div><p><strong>The <code>--criteria</code> option replaces the <code>tags</code> option starting with Anypoint CLI version v3.17.0.</strong> In versions prior to v3.17.0, the <code>tags</code> option is followed by a comma separated list of tags to be applied to the new governance profile, formatted as follows: <code>tag1,tag2,tag3</code></p></div></div></td></tr><tr><td><div><div><p>--description &lt;description&gt;</p></div></div></td><td><div><div><p>The <code>description</code> option is followed by a string that is the new governance profile description.</p></div></div></td></tr><tr><td><div><div><p>--notify-off</p></div></div></td><td><div><div><p>Disables notifications.</p></div></div></td></tr><tr><td><div><div><p>--notify-contact</p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the contact set for the API.</p></div></div></td></tr><tr><td><div><div><p>--notify-publisher</p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the API publisher.</p></div></div></td></tr><tr><td><div><div><p>--notify-others &lt;email ID,email ID,…​&gt;</p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the specified list of email IDs.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli governance profile update 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 --profile-name "MyOrg Best Practices"

anypoint-cli governance profile update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,status:development,scope:rest-api`

anypoint-cli governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-publisher  --notify-contact --notify-others a@a.a,b@b.com

anypoint-cli governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-off

anypoint-cli governance profile update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,status:production,scope:rest-api,env-type:production` --ruleset-gavs 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/latest
```

**Example output:**

Profile updated 51f9f94c-fb0c-43d4-9895-22c9e64f1537

### Limitations

You cannot configure notifications using the `governance profile update` command. After you create a
profile using the CLI, you can configure notifications by editing the profile in the API Governance
console. See
[Update a Governance Profile Using the API Governance Console](https://docs.mulesoft.com/api-governance/create-profiles#update-a-governance-profile-using-the-api-governance-console).

## governance ruleset clone

`> governance ruleset clone [options] <ruleset> <new_title> <new_description>`

This command clones a governance ruleset to create a new custom ruleset and applies specified
updates to rules based on the options. The new ruleset is written to standard output.

The `new-title` parameter gives the title for the new ruleset.

The `new description` parameter gives the description for the new ruleset.

> [!TIP] Run the `governance ruleset info` command before running this command to get the rule ID
> information to use in this command.

Besides the default options `--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>--remote</p></div></div></td><td><div><div><p>Indicates that the ruleset to clone is published in Exchange and that the <code>ruleset</code> parameter is the asset identifier for the ruleset. An asset identifier is the group ID, asset ID, and version (GAV) that uniquely identifies each asset in Exchange. For example: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code></p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers (GAVs)</a>.</p></div></div></td></tr><tr><td><div><div><p>--error=&lt;list_rules_to_move_to_error&gt;</p></div></div></td><td><div><div><p>The <code>error</code> option is followed by the rule IDs for the rules to move to the error severity level section of the ruleset YAML.</p></div></div></td></tr><tr><td><div><div><p>--warning=&lt;list_rules_to_move_to_warning&gt;</p></div></div></td><td><div><div><p>The <code>warning</code> option is followed by the rule IDs for the rules to move to the warning severity level section of the ruleset YAML.</p></div></div></td></tr><tr><td><div><div><p>--info=&lt;list_rules_to_move_to_info&gt;</p></div></div></td><td><div><div><p>The <code>info</code> option is followed by the rule IDs for the rules to move to the info severity level section of the ruleset YAML.</p></div></div></td></tr><tr><td><div><div><p>--remove=&lt;list_rules_to_disable&gt;</p></div></div></td><td><div><div><p>The <code>remove</code> option is followed by the rule IDs for the rules to comment out, and therefore effectively disable, in the ruleset YAML.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli governance ruleset clone ~/Downloads/ruleset.yaml 'New Ruleset from Clone' 'Cloned from ruleset.yaml' --warning=operation-default-response,operation-operationId > mynewruleset.yaml

anypoint-cli governance ruleset clone 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.2 'Custom Anypoint Best Practices' 'Cloned from MuleSoft Anypoint Best Practices' --remote --remove=openapi-tags,operation-tags > my-anypoint-best-practices.yaml
```

## governance ruleset info

`> governance ruleset info [options] <governance-ruleset>`

This command lists the ruleset rules in the ruleset definition passed in the `governance-ruleset`
parameter.

Besides the default options `--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>--remote</p></div></div></td><td><div><div><p>Indicates that the ruleset for which to get information is published in Exchange and that the <code>ruleset</code> parameter is the asset identifier for the ruleset. An asset identifier is the group ID, asset ID, and version (GAV) that uniquely identifies an asset in Exchange. For example: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code>, where <code>&lt;version&gt;</code> is a specific version or <code>latest</code>. If you use <code>latest</code> as the version, the profile automatically uses the latest version of the ruleset when versions are published after you create the profile.</p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers (GAVs)</a>.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli governance ruleset info ~/temp/myruleset.yaml

anypoint-cli governance ruleset info 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.2 --remote

anypoint-cli governance ruleset info 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/latest --remote
```

**Example output:**

Ruleset /Users/myuser/temp/myruleset.yaml Violation operation-default-response Violation
operation-operationId Warning operation-singular-tag Warning tag-description Warning info-contact
Warning info-description Warning info-license Warning license-url Warning openapi-tags Warning
operation-description Warning operation-tags Warning operation-tag-defined

## governance ruleset init

`> governance ruleset init [options] <schema>`

This command initializes a ruleset based on the data schema passed in the `schema` parameter.

Besides the default options `--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>--types &lt;types&gt;</p></div></div></td><td><div><div><p>The <code>types</code> option gives the target types to export as rules. You can use the <code>governance api inspect</code> command to identify the types to specify in this option. See <a href="#governance-api-inspect">governance api inspect</a>.</p></div></div></td></tr><tr><td><div><div><p>--name &lt;name&gt;</p></div></div></td><td><div><div><p>The <code>name</code> option is the name of the ruleset. Defaults to <code>GeneratedRuleset</code>.</p></div></div></td></tr></tbody></table>

**Example command:**

```copy
anypoint-cli governance ruleset init --types patientmultipleBirthBoolean,patientBundle,patientmultipleBirthInteger --name=my-ruleset mydataschema
```

## governance ruleset validate

`> governance ruleset validate [options] <governance-ruleset>`

This command validates the ruleset definitions passed using the `governance-ruleset` parameter. You
can pass one of the following as the `governance-ruleset` parameter:

- A ruleset definition YAML file

- A ZIP file that contains an API project with an `exchange.json` file that specifies the ruleset as
  the main file

- A folder that contains an API project with an `exchange.json` file that specifies the ruleset as
  the main file

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

**Example commands:**

```copy
anypoint-cli governance ruleset validate ~/temp/myruleset.yaml

anypoint-cli governance ruleset validate ~/temp/myruleset.zip

anypoint-cli governance ruleset validate ~/temp/myrulesetfolder
```

**Example output for a valid ruleset:**

Ruleset conforms with Dialect

**Example output for a nonvalid ruleset:**

Ruleset does not conform with Dialect ModelId: file:///Users/janedoe/temp/prof-1-bad.yaml Profile:
Validation Profile 1.0 Conforms: false Number of results: 1

Level: Violation

- Constraint:
  http://a.ml/amf/default\_document#/declarations/profileNode\_profile\_required\_validation
  Message: Property 'profile' is mandatory Severity: Violation Target:
  file:///Users/janedoe/temp/prof-1-bad.yaml#/encodes Property: http://schema.org/name Range:
  \[(3,0)-(11,19)\] Location: file:///Users/janedoe/temp/prof-1-bad.yaml

### Get Exchange Asset Identifiers (GAVs)

To get the GAVs for Exchange assets:

- If you are using the Exchange CLI, run the `anypoint-cli exchange asset list` command.

- If you are using the Exchange web UI, select the asset in Exchange and then copy the group ID and
  asset ID from the URL. Add the version node for the version you are viewing. For example, the GAV
  for the OpenAPI Best Practices ruleset in Exchange is
  `68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1`.

<!-- document id=69c461a27a72a84a8b251648a3e139e89abed070dd794e5d0bd21cc3a12dee4d url=/mulesoft/current/en-us/anypoint-cli/latest/api-governance.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for API Governance

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

Use the `governance` commands to automate your API Governance processes. For more information about
how to use these commands, refer to the [API Governance documentation](https://docs.mulesoft.com/api-governance/).

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Command</p></td><td><p>Description</p></td></tr><tr><td><p><a href="#governance-api-evaluate">governance:api:evaluate</a></p></td><td><p>Evaluates filter criteria to determine which rulesets apply to APIs that meet that criteria</p></td></tr><tr><td><p><a href="#governance-api-inspect">governance:api:inspect</a></p></td><td><p>Inspects an API specification and lists its schemas</p></td></tr><tr><td><p><a href="#governance-api-validate">governance:api:validate</a></p></td><td><p>Validates an API specification against a specified governance ruleset</p></td></tr><tr><td><p><a href="#governance-document">governance:document</a></p></td><td><p>Creates the documentation file for a governance ruleset definition</p></td></tr><tr><td><p><a href="#governance-profile-create">governance:profile:create</a></p></td><td><p>Creates an active governance profile</p></td></tr><tr><td><p><a href="#governance-profile-delete">governance:profile:delete</a></p></td><td><p>Deletes a governance profile</p></td></tr><tr><td><p><a href="#governance-profile-info">governance:profile:info</a></p></td><td><p>Lists information for a specific governance profile ID</p></td></tr><tr><td><p><a href="#governance-profile-list">governance:profile:list</a></p></td><td><p>Lists all governance profiles for an organization</p></td></tr><tr><td><p><a href="#governance-profile-update">governance:profile:update</a></p></td><td><p>Updates a governance profile</p></td></tr><tr><td><p><a href="#governance-ruleset-clone">governance:ruleset:clone</a></p></td><td><p>Clones a governance ruleset and applies specified updates to rules</p></td></tr><tr><td><p><a href="#governance-ruleset-classes">governance:ruleset:classes</a></p></td><td><p>Lists the target classes available for governance rulesets, grouped by prefix</p></td></tr><tr><td><p><a href="#governance-ruleset-completions">governance:ruleset:completions</a></p></td><td><p>Returns context-aware completions at a cursor position in a ruleset YAML file</p></td></tr><tr><td><p><a href="#governance-ruleset-constraints">governance:ruleset:constraints</a></p></td><td><p>Lists valid constraints by property type</p></td></tr><tr><td><p><a href="#governance-ruleset-domains">governance:ruleset:domains</a></p></td><td><p>Lists available metadata domains for governance rulesets</p></td></tr><tr><td><p><a href="#governance-ruleset-generate">governance:ruleset:generate</a></p></td><td><p>Returns context and instructions for generating a ruleset from a natural-language description</p></td></tr><tr><td><p><a href="#governance-ruleset-info">governance:ruleset:info</a></p></td><td><p>Lists ruleset rules</p></td></tr><tr><td><p><a href="#governance-ruleset-init">governance:ruleset:init</a></p></td><td><p>Initializes a governance ruleset definition based on a data schema</p></td></tr><tr><td><p><a href="#governance-ruleset-properties">governance:ruleset:properties</a></p></td><td><p>Lists the properties and types for a target class</p></td></tr><tr><td><p><a href="#governance-ruleset-resolve">governance:ruleset:resolve</a></p></td><td><p>Resolves a user-facing term to its canonical target class and property path</p></td></tr><tr><td><p><a href="#governance-ruleset-simplify">governance:ruleset:simplify</a></p></td><td><p>Simplifies a ruleset by flattening nested paths and removing redundant logical wrappers</p></td></tr><tr><td><p><a href="#governance-ruleset-validate">governance:ruleset:validate</a></p></td><td><p>Validates a governance ruleset definition’s format</p></td></tr><tr><td><p><a href="#governance-ruleset-validate-authoring">governance:ruleset:validate-authoring</a></p></td><td><p>Validates a ruleset against the authoring model</p></td></tr><tr><td><p><a href="#governance-ruleset-version">governance:ruleset:version</a></p></td><td><p>Shows the governance ruleset tooling version</p></td></tr></tbody></table>

## governance:api:evaluate

`> governance:api:evaluate [flags]`

Evaluates specified filters to determine the rulesets that would be applied to your APIs that meet
that criteria.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--api=&lt;api&gt;</code></p></div></div></td><td><div><div><p>The API project against which you want to evaluate. The command uses the criteria in the project’s <code>exchange.json</code> file.</p></div></div></td></tr><tr><td><div><div><p><code>--criteria &lt;filtertype:filtervalue&gt;,…​</code></p></div></div></td><td><div><div><p>Enables you to apply filters to select the list of APIs to which the profile rulesets apply. Specify a list of comma-separated filters where each filter has a type and value in the format <code>filtertype:filtervalue</code>.</p></div><div><p>Available filters include:</p></div><div><ul><li><p><code>scope</code>: API type. Supported values are: <code>async-api</code>, <code>http-api</code>, or <code>rest-api</code>.</p></li><li><p><code>tag</code>: Tag defined for APIs in Exchange.</p></li><li><p><code>category</code>: Category defined for APIs in Exchange, where the filter value is specified in two parts as <code>categoryName:value</code>.</p></li><li><p><code>env-type</code>: Environment type. Supported values are: <code>any</code>, <code>production</code>, or <code>sandbox</code>.</p></li><li><p><code>env-id</code>: The ID for the environment name in API Manager. You can get this value using <strong>API Manager</strong> &gt; <strong>Environment information</strong>. See <a href="https://docs.mulesoft.com/api-manager/latest/environments-concept">Reviewing Environment Concepts</a>.</p><div><p>If <code>env-type</code> or <code>env-id</code> is used, the <strong>API Instance</strong> filter is set in the profile, so that only APIs that have instances are filtered.</p></div><div><p>To deselect the <strong>API Instance</strong> filter in the profile using the CLI, update the profile using the <code>--criteria</code> flag with neither <code>env-type</code> nor <code>env-id</code>.</p></div></li></ul></div><div><p>Example: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production</p></div></div></td></tr></tbody></table>

> [!NOTE] This command must be run with either the `--criteria` or the `--api` flag.

**Example commands:**

`anypoint-cli-v4 governance:api:evaluate --criteria "tag:best,category:API Type:Experience API,scope:rest-api"`

`anypoint-cli-v4 governance:api:evaluate --api order-api-1.0.0-raml.zip`  
where `order-api-1.0.0-raml.zip` contains an API and its `exchange.json` file

**Example output:**

╔════════════════════════════════════════════════════════════════════╗ ║ Ruleset GAV ║
╟────────────────────────────────────────────────────────────────────╢ ║
68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.5.1 ║
╟────────────────────────────────────────────────────────────────────╢ ║
68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.1 ║
╚════════════════════════════════════════════════════════════════════╝

## governance:api:inspect

`> governance:api:inspect [flags] <api-specification>`

Inspects the API specification passed in `api-specification` and lists all its schemas, such as
headers, requests, and response payloads. You can use this schema information in the
`governance:ruleset:init` command. See [governance:ruleset:init](#governance-ruleset-init).

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example command:**

```copy
anypoint-cli-v4 governance:api:inspect my-healthcare-api.yaml
```

**Example schema**

```copy
types:
  patientmultipleBirthBoolean:
    properties:
      multipleBirthBoolean:
        description: Whether patient is part of a multiple birth
        type: boolean
  patientmultipleBirthInteger:
    properties:
      multipleBirthInteger:
        description: Whether patient is part of a multiple birth
        type: integer

        .
        .
        .

  PatientEntry:
    type: FHIR_commons.Entry
    properties:
      resource: Patient

  PatientBundle:
    type: FHIR_commons.Bundle
    properties:
      entry?: PatientEntry[]
```

**Example output:**

'patientmultipleBirthBoolean', 'PatientBundle', 'patientmultipleBirthInteger', 'PatientEntry'

## governance:api:validate

`> governance:api:validate <api-specification> [flags]`

Validates the API specification passed in `api-specification` against specified rulesets.

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use "-- " (two dashes followed by a space) before the
> parameter.

You can specify `api-specification` as one of the following:

- An API project ZIP file

- An API project folder

- An asset identifier for an API project, if the `--remote` flag is specified. An asset identifier
  is a group ID, asset ID, and version (GAV) that uniquely identifies each asset in Exchange.

You can specify rulesets against which to validate as follows:

- To use an existing `exchange.json` file that defines your API project’s ruleset dependencies,
  ensure that the `exchange.json` file is included in the folder or ZIP file that you specify in
  `api-specification`. If the `exchange.json` file is present, the command downloads all of the
  ruleset dependencies and validates against those rulesets. The ruleset dependencies are present in
  the `exchange.json` file only if dependencies are defined for that API project in API Designer.
  See [Add Rulesets to Your Project](https://docs.mulesoft.com/api-governance/find-conformance-issues#add-rulesets).

- To validate directly against rulesets published in Exchange, use the `--remote-rulesets` flag.

- To validate against local rulesets, use the `--rulesets` flag.

> [!NOTE] Duplicate rulesets are not detected, so if you use more than one of the preceding ways of
> identifying rulesets in the same command execution, some rulesets might be validated multiple
> times.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--rulesets &lt;ruleset-yaml-file1&gt; &lt;ruleset-yaml-file2&gt; …​</code></p></div></div></td><td><div><div><p>Local ruleset definitions. The <code>rulesets</code> flag is followed by a list of ruleset YAML files separated by spaces.</p></div></div></td></tr><tr><td><div><div><p><code>--remote-rulesets &lt;ruleset-asset-identifier&gt; &lt;ruleset-asset-identifier&gt; …​</code></p></div></div></td><td><div><div><p>Remote ruleset definitions. The <code>remote-rulesets</code> flag is followed by a list of ruleset asset identifiers separated by spaces. An asset identifier is a group ID, asset ID, and version (GAV) that uniquely identifies each asset in Exchange. For example: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;,&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code></p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers</a>.</p></div></div></td></tr><tr><td><div><div><p><code>--remote</code></p></div></div></td><td><div><div><p>Flag to indicate that the validation should be done against a published API. The value passed in <code>api-specification</code> is the API’s asset identifier. An asset identifier is a group ID, asset ID, and version (GAV) that uniquely identifies each asset in Exchange. For example: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code></p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers</a>.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli-v4 governance:api:validate /MyApis/order-api-1.0.0-raml.zip

anypoint-cli-v4 governance:api:validate /MyApis/order-api-1.0.0-raml

anypoint-cli-v4 governance:api:validate /MyApis/order-api-1.0.0-raml.zip --rulesets /MyRulesets/ruleset1.yaml /MyRulesets/ruleset2.yaml

anypoint-cli-v4 governance:api:validate /MyApis/order-api-1.0.0-raml.zip --remote-rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1

anypoint-cli-v4 governance:api:validate 8a840abd-e63a-4f8b-87ab-24052eda2017/order-api/1.0.0 --remote-rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --remote
```

**Example output:**

For a specification that is conformant to the ruleset:

Spec conforms with Ruleset

For a specification that is nonconformant to the ruleset:

Conforms: false Number of results: 3 **(1)**

Functional Validations
----------------------

Constraint: http://a.ml/vocabularies/amf/core#declaration-not-found Severity: Violation Message: not
supported scalar for documentation Target: null Range: \[(6,3)-(6,3)\] Location:
file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml

Conformance Validations **(2)**
-----------------------

Constraint:
file:///exchange\_modules/68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0/ruleset.yaml#/encodes/validations/api-must-have-documentation
**(3)** Severity: Warning **(4)** Message: Provide the documentation for the API. **(5)** Target:
amf://id#2 **(6)** Range: \[(2,0)-(6,4)\] **(7)** Location:
file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml **(8)**

Constraint:
file:///exchange\_modules/8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0/bestpractices.yaml#/encodes/validations/api-must-have-documentation
Severity: Violation Message: Provide the documentation for the API Target: amf://id#2 Range:
\[(2,0)-(6,4)\] Location: file:///Users/myuser/Downloads/order-api-1.0.0-raml/order-api-1.0.0-raml

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>Total of functional and conformance validation issues found</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Conformance issues section</td></tr><tr><td><i data-value="3"></i><b>3</b></td><td>Ruleset and rule to which this set of issues applies</td></tr><tr><td><i data-value="4"></i><b>4</b></td><td>Severity level for the issue</td></tr><tr><td><i data-value="5"></i><b>5</b></td><td>Description of the issue</td></tr><tr><td><i data-value="6"></i><b>6</b></td><td>AMF model node ID; for information on the AMF model, see <a href="https://docs.mulesoft.com/api-governance/create-custom-rulesets">Creating Custom Governance Rulesets</a></td></tr><tr><td><i data-value="7"></i><b>7</b></td><td>Beginning line number and column and end line number and column in the API specification where the issue occurs, where column is the offset from the beginning of the line and numbering for the offset starts at 0</td></tr><tr><td><i data-value="8"></i><b>8</b></td><td>The file in which the issue occurs, either the main file or one of its dependencies</td></tr></tbody></table>

## governance:document

`> governance:document [flags] <ruleset> <doc-file>`

Creates the documentation for the API Governance ruleset definition ZIP file specified in `ruleset`.
It puts the documentation in the `doc-file` ZIP file for you to upload and publish to Exchange.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example command:**

```copy
anypoint-cli-v4 governance:document /myrulesetfolder/mynewruleset.yaml /myrulesetfolder/ruleset.doc.zip
```

**Example output:**

validation name \[ 'security-fields-operation-empty' \] validation name \[
'access-tokens-oauth2-cleartext' \] validation name \[ 'insecure-oauth2-grants' \] validation name
\[ 'api-keys-in-cookie' \] validation name \[ 'api-keys-in-query' \] validation name \[
'api-keys-in-header' \] validation name \[ 'api-negotiates-authentication' \] validation name \[
'insecure-basic-auth' \] validation name \[ 'bearer-token-cleartext' \] validation name \[
'http-token-cleartext' \] validation name \[ 'oauth1-deprecated' \] validation name \[
'oauth2-redirections-non-encrypted' \] validation name \[ 'unknown-security-scheme' \] validation
name \[ 'valid-server-urltemplate' \] validation name \[ 'valid-oauth2-redirection-urls' \] Saving
to myRulesetFolder/ruleset.doc.zip

## governance:profile:create

`> governance:profile:create [flags] <profile-name> <ruleset-asset-identifiers>`

Creates an active governance profile using a string value for the new governance profile name
specified in `profile-name`.

You must include `ruleset-asset-identifiers`, a comma-separated list of ruleset asset identifiers,
each of which is the group ID, asset ID, and version (GAV) that uniquely identifies each asset in
Exchange. For example: `<group_id>/<asset_id>/<version>,<group_id>/<asset_id>/<version>`, where
`<version>` is a specific version or `latest`. If you use `latest` as the version, the profile
automatically uses the latest version of the ruleset when versions are published after you create
the profile. See [Get Exchange Asset Identifiers](#exchange-asset-identifiers).

You can use one of the `notify` flags to configure notifications for the profile you are creating.
If you do not use a `notify` flag, no notifications are configured by the command. Notifications are
off by default.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--criteria &lt;filtertype:filtervalue&gt;,…​</code></p></div></div></td><td><div><div><p>Enables you to apply filters to select the list of APIs to which the profile rulesets apply. Specify a list of comma-separated filters where each filter has a type and value in the format <code>filtertype:filtervalue</code>.</p></div><div><p>Available filters include:</p></div><div><ul><li><p><code>scope</code>: API type. Supported values are: <code>async-api</code>, <code>http-api</code>, or <code>rest-api</code>.</p></li><li><p><code>tag</code>: Tag defined for APIs in Exchange.</p></li><li><p><code>category</code>: Category defined for APIs in Exchange, where the filter value is specified in two parts as <code>categoryName:value</code>.</p></li><li><p><code>env-type</code>: Environment type. Supported values are: <code>any</code>, <code>production</code>, or <code>sandbox</code>.</p></li><li><p><code>env-id</code>: The ID for the environment name in API Manager. You can get this value using <strong>API Manager</strong> &gt; <strong>Environment information</strong>. See <a href="https://docs.mulesoft.com/api-manager/latest/environments-concept">Reviewing Environment Concepts</a>.</p><div><p>If <code>env-type</code> or <code>env-id</code> is used, the <strong>API Instance</strong> filter is set in the profile, so that only APIs that have instances are filtered.</p></div><div><p>To deselect the <strong>API Instance</strong> filter in the profile using the CLI, update the profile using the <code>--criteria</code> flag with neither <code>env-type</code> nor <code>env-id</code>.</p></div></li></ul></div><div><p>Example: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production</p></div></div></td></tr><tr><td><div><div><p><code>--description &lt;description&gt;</code></p></div></div></td><td><div><div><p>The <code>description</code> flag is followed by a string that is the new governance profile’s description.</p></div></div></td></tr><tr><td><div><div><p><code>--notify-contact</code></p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the contact set for the API.</p></div></div></td></tr><tr><td><div><div><p><code>--notify-publisher</code></p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the API publisher.</p></div></div></td></tr><tr><td><div><div><p><code>--notify-others &lt;email ID,email ID,…​&gt;</code></p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the specified list of email IDs.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli-v4 governance:profile:create "OAS Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --criteria "tag:oas,category:API Type:Experience API,scope:rest-api" --description "Profile for OAS Best Practices"

anypoint-cli-v4 governance:profile:create "Open API Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 --criteria "tag:oas,category:API Type:Experience API,scope:rest-api" --description "Profile for OAS Best Practices"

anypoint-cli-v4 governance:profile:create "Anypoint Best Practices" 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-api-best-practices/1.0.1 --criteria "tag:raml tag:oas category:API Type:Experience API,scope:rest-api" --description "Profile for REST API Best Practices" --notify-publisher  --notify-contact --notify-others a@a.a,b@b.com

anypoint-cli-v4 governance:profile:create "Primary API Standards" 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/1.0.2 --criteria "tag:prim,category:API Type:Experience API,scope:rest-api" --description "Profile for Primary API Standards"
```

**Example output:**

Profile Added Id 4f98e59d-8efb-420f-ac95-9cd0af15bd45 Name OAS Best Practices Description Profile
for OAS Best Practices Rulesets
gav://68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1 Filter tag:best

## governance:profile:delete

`> governance:profile:delete [flags] <profile-id>`

Deletes a specific governance profile specified by `profile-id`. To get this ID, run the
`governance:profile:info` or `governance:profile:list` command.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example command:**

```copy
anypoint-cli-v4 governance:profile:delete 8ffd463f-86b2-4132-afc6-44d179209362
```

**Example output:**

Profile with id 8ffd463f-86b2-4132-afc6-44d179209362 removed

## governance:profile:info

`> governance:profile:info [flags] <profile-id>`

Lists all information for a governance profile ID

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--output &lt;output-format&gt;</code></p></div></div></td><td><div><div><p>Format for the command output. Supported values are <code>table</code> (default) and <code>json</code>.</p></div></div></td></tr></tbody></table>

**Example command:**

```copy
anypoint-cli-v4 governance:profile:info 19fb211b-8775-43cc-865a-46228921d6ed
```

**Example output:**

Id 19fb211b-8775-43cc-865a-46228921d6ed Name Best Practices Description Best Practices Profile
Rulesets 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.0
8a840abd-e63a-4f8b-87ab-24052eda2017/best-practices-ruleset/1.0.0
68ef9520-24e9-4cf2-b2f5-620025690913/required-examples/1.0.0 Criteria tag:best,category:API
Type:Experience API,scope:rest-api NotificationConfig Contact,Publisher

## governance:profile:list

`> governance:profile:list [flags]`

Lists information for all governance profiles for an organization. You need this information when
updating a governance profile.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--output &lt;output-format&gt;</code></p></div></div></td><td><div><div><p>Format for the command output. Supported values are <code>table</code> (default) and <code>json</code>.</p></div></div></td></tr></tbody></table>

**Example command:**

```copy
anypoint-cli-v4 governance:profile:list
```

**Example output:**

Profile Name Profile Id

Minimum Security Requirements 1f418cf4-b870-4b31-8734-f55f28d45f8f Best Practices
19fb211b-8775-43cc-865a-46228921d6ed New Best Practices 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 OAS
Standards 51ae8795-2278-407e-942f-becba29af986

## governance:profile:update

`> governance:profile:update [flags] <profile-id>`

Updates the governance profile specified in `profile-id`. To get this ID, run the
`governance:profile:info` or `governance:profile:list` command.

You can update the governance profile’s general information, rulesets, filter criteria, and
notification configuration. You can use one of the `notify` flags to update the notification
configuration or turn off notifications. Any changes override existing notification configurations.
If you do not use a `notify` flag, no changes are made to the notification configuration.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--profile-name &lt;profile-name&gt;</code></p></div></div></td><td><div><div><p>The <code>profile-name</code> flag is followed by a string that is the new governance profile name.</p></div></div></td></tr><tr><td><div><div><p><code>--ruleset-gavs &lt;ruleset-gavs&gt;</code></p></div></div></td><td><div><div><p>The <code>ruleset-gavs</code> flag is followed by a list with the asset identifier for each ruleset, formatted as follows: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;,&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code>, where <code>&lt;version&gt;</code> is a specific version or <code>latest</code>. An asset identifier is a unique group ID, asset ID, and version (GAV) that identifies each asset in Exchange. If you use <code>latest</code> as the version, the profile automatically uses the latest version of the ruleset when versions are published after you create the profile.</p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers</a>.</p></div></div></td></tr><tr><td><div><div><p><code>--criteria &lt;filtertype:filtervalue&gt;,…​</code></p></div></div></td><td><div><div><p>Enables you to apply filters to select the list of APIs to which the profile rulesets apply. Specify a list of comma-separated filters where each filter has a type and value in the format <code>filtertype:filtervalue</code>.</p></div><div><p>Available filters include:</p></div><div><ul><li><p><code>scope</code>: API type. Supported values are: <code>async-api</code>, <code>http-api</code>, or <code>rest-api</code>.</p></li><li><p><code>tag</code>: Tag defined for APIs in Exchange.</p></li><li><p><code>category</code>: Category defined for APIs in Exchange, where the filter value is specified in two parts as <code>categoryName:value</code>.</p></li><li><p><code>env-type</code>: Environment type. Supported values are: <code>any</code>, <code>production</code>, or <code>sandbox</code>.</p></li><li><p><code>env-id</code>: The ID for the environment name in API Manager. You can get this value using <strong>API Manager</strong> &gt; <strong>Environment information</strong>. See <a href="https://docs.mulesoft.com/api-manager/latest/environments-concept">Reviewing Environment Concepts</a>.</p><div><p>If <code>env-type</code> or <code>env-id</code> is used, the <strong>API Instance</strong> filter is set in the profile, so that only APIs that have instances are filtered.</p></div><div><p>To deselect the <strong>API Instance</strong> filter in the profile using the CLI, update the profile using the <code>--criteria</code> flag with neither <code>env-type</code> nor <code>env-id</code>.</p></div></li></ul></div><div><p>Example: tag:tag1,category:category1:value,category:category2:value2,scope:rest-api,scope:async-api,env-type:production</p></div></div></td></tr><tr><td><div><div><p><code>--description &lt;description&gt;</code></p></div></div></td><td><div><div><p>The <code>description</code> flag is followed by a string that is the new governance profile description.</p></div></div></td></tr><tr><td><div><div><p><code>--notify-off</code></p></div></div></td><td><div><div><p>Disables notifications.</p></div></div></td></tr><tr><td><div><div><p><code>--notify-contact</code></p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the contact set for the API.</p></div></div></td></tr><tr><td><div><div><p><code>--notify-publisher</code></p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the API publisher.</p></div></div></td></tr><tr><td><div><div><p><code>--notify-others &lt;email ID,email ID,…​&gt;</code></p></div></div></td><td><div><div><p>Enables notifications and sets the recipient to the specified list of email IDs.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli-v4 governance:profile:update 4eaf9176-3ef9-4021-a67c-6e4bc10d3763 --profile-name "MyOrg Best Practices"

anypoint-cli-v4 governance:profile:update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,scope:rest-api`

anypoint-cli-v4 governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-publisher  --notify-contact --notify-others a@a.a,b@b.com

anypoint-cli-v4 governance profile update 67eff44a-28a3-43d4-93d9-bddedb92c711 --notify-off

anypoint-cli-v4 governance profile update 19fb211b-8775-43cc-865a-46228921d6ed --criteria `tag:best,category:API Type:Experience API,scope:rest-api,env-type:production` --ruleset-gavs 68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/latest,68ef9520-24e9-4cf2-b2f5-620025690913/myorg-best-practices/latest
```

**Example output:**

Profile updated 51f9f94c-fb0c-43d4-9895-22c9e64f1537

## governance:ruleset:classes

`> governance:ruleset:classes [flags]`

Lists the target classes available for governance rulesets, grouped by prefix. Prints the total
count of targetable classes.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--domain &lt;domain&gt;</code></p></div></div></td><td><div><div><p>Filters the list to classes belonging to the specified domain. Supported values are <code>api-spec</code>, <code>mcp</code>, <code>api-project</code>, <code>governance</code>, and <code>community</code>. To see all available domains, run the <code>governance:ruleset:domains</code> command.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli-v4 governance:ruleset:classes

anypoint-cli-v4 governance:ruleset:classes --domain api-spec
```

## governance:ruleset:clone

`> governance:ruleset:clone [flags] <ruleset> <new_title> <new_description>`

Clones a governance ruleset to create a new custom ruleset and applies specified updates to rules
based on the flags. The new ruleset is written to standard output.

The `new-title` parameter gives the title for the new ruleset.

The `new description` parameter gives the description for the new ruleset.

> [!TIP] Run the `governance:ruleset:info` command before running this command to get the rule ID
> information to use in this command.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--remote</code></p></div></div></td><td><div><div><p>Indicates that the ruleset to clone is published in Exchange and that the <code>ruleset</code> parameter is the asset identifier for the ruleset. An asset identifier is the group ID, asset ID, and version (GAV) that uniquely identifies each asset in Exchange. For example: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code></p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers</a>.</p></div></div></td></tr><tr><td><div><div><p><code>--error=&lt;list_rules_to_move_to_error&gt;</code></p></div></div></td><td><div><div><p>The <code>error</code> flag is followed by the rule IDs for the rules to move to the error severity level section of the ruleset YAML.</p></div></div></td></tr><tr><td><div><div><p><code>--warning=&lt;list_rules_to_move_to_warning&gt;</code></p></div></div></td><td><div><div><p>The <code>warning</code> flag is followed by the rule IDs for the rules to move to the warning severity level section of the ruleset YAML.</p></div></div></td></tr><tr><td><div><div><p><code>--info=&lt;list_rules_to_move_to_info&gt;</code></p></div></div></td><td><div><div><p>The <code>info</code> flag is followed by the rule IDs for the rules to move to the info severity level section of the ruleset YAML.</p></div></div></td></tr><tr><td><div><div><p><code>--remove=&lt;list_rules_to_disable&gt;</code></p></div></div></td><td><div><div><p>The <code>remove</code> flag is followed by the rule IDs for the rules to comment out, and therefore effectively disable, in the ruleset YAML.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli-v4 governance:ruleset:clone ~/Downloads/ruleset.yaml 'New Ruleset from Clone' 'Cloned from ruleset.yaml' --warning=operation-default-response,operation-operationId > mynewruleset.yaml

anypoint-cli-v4 governance:ruleset:clone 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.2 'Custom Anypoint Best Practices' 'Cloned from MuleSoft Anypoint Best Practices' --remote --remove=openapi-tags,operation-tags > my-anypoint-best-practices.yaml
```

## governance:ruleset:completions

`> governance:ruleset:completions [flags] <ruleset>`

Returns context-aware completions at a specific cursor position in the ruleset YAML file specified
in `ruleset`. Intended for editor and tooling integration.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--offset &lt;offset&gt;</code></p></div></div></td><td><div><div><p>The cursor offset in the file. Required.</p></div></div></td></tr><tr><td><div><div><p><code>--line-text &lt;line-text&gt;</code></p></div></div></td><td><div><div><p>The current line text up to the cursor. Required.</p></div></div></td></tr></tbody></table>

**Example command:**

```copy
anypoint-cli-v4 governance:ruleset:completions my-ruleset.yaml --offset 120 --line-text "    targetClass: "
```

## governance:ruleset:constraints

`> governance:ruleset:constraints [flags]`

Lists the valid constraints for each property type: `scalar`, `node`, `scalarArray`, and
`nodeArray`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--type &lt;type&gt;</code></p></div></div></td><td><div><div><p>Filters the list to constraints for the specified property type. Supported values are <code>scalar</code>, <code>node</code>, <code>scalarArray</code>, and <code>nodeArray</code>.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli-v4 governance:ruleset:constraints

anypoint-cli-v4 governance:ruleset:constraints --type scalar

anypoint-cli-v4 governance:ruleset:constraints --type nodeArray
```

## governance:ruleset:domains

`> governance:ruleset:domains`

Lists the available metadata domains for governance rulesets. For each domain, the command prints
the name, description, class count, and (when applicable) spec kind.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example command:**

```copy
anypoint-cli-v4 governance:ruleset:domains
```

## governance:ruleset:generate

`> governance:ruleset:generate [flags] <intent>`

Returns the context and step-by-step instructions for generating a governance ruleset in Validation
Profile 1.0 YAML format from the natural-language description provided in `intent`. When an API spec
is provided, the command detects the spec type to include as context.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--api-spec &lt;api-spec&gt;</code></p></div></div></td><td><div><div><p>Path to an API spec for context extraction. The command detects whether the spec is RAML or OpenAPI.</p></div></div></td></tr><tr><td><div><div><p><code>--attempt &lt;attempt&gt;</code></p></div></div></td><td><div><div><p>Retry attempt number. Values greater than <code>1</code> append a note to fix errors from the previous attempt. Defaults to <code>1</code>.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli-v4 governance:ruleset:generate "Every operation must have a description"

anypoint-cli-v4 governance:ruleset:generate "Require rate-limit policy" --api-spec openapi.yaml
```

## governance:ruleset:info

`> governance:ruleset:info <governance-ruleset> [flags]`

Lists the ruleset rules in the ruleset definition passed in the `governance-ruleset` parameter.

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use "-- " (two dashes followed by a space) before the
> parameter.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--remote</code></p></div></div></td><td><div><div><p>Indicates that the ruleset for which to get information is published in Exchange and that the <code>ruleset</code> parameter is the asset identifier for the ruleset. An asset identifier is the group ID, asset ID, and version (GAV) that uniquely identifies an asset in Exchange. For example: <code>&lt;group_id&gt;/&lt;asset_id&gt;/&lt;version&gt;</code>, where <code>&lt;version&gt;</code> is a specific version or <code>latest</code>. If you use <code>latest</code> as the version, the profile automatically uses the latest version of the ruleset when versions are published after you create the profile.</p></div><div><p>See <a href="#exchange-asset-identifiers">Get Exchange Asset Identifiers</a>.</p></div></div></td></tr></tbody></table>

**Example commands:**

```copy
anypoint-cli-v4 governance:ruleset:info myrulesetfolder/myruleset.yaml

anypoint-cli-v4 governance:ruleset:info 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/1.0.2 --remote

anypoint-cli-v4  governance:ruleset:info 68ef9520-24e9-4cf2-b2f5-620025690913/anypoint-best-practices/latest --remote
```

**Example output:**

Ruleset myrulesetfolder/myruleset.yaml Ruleset conforms with Dialect
╔═══════════╤═══════════════════════════════════╗ ║ Violation │ security-fields-operation-empty ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ access-tokens-oauth2-cleartext ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ insecure-oauth2-grants ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ api-keys-in-cookie ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ api-keys-in-query ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ api-keys-in-header ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ api-negotiates-authentication ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ insecure-basic-auth ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ bearer-token-cleartext ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ http-token-cleartext ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ oauth2-redirections-non-encrypted ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ unknown-security-scheme ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ valid-server-urltemplate ║
╟───────────┼───────────────────────────────────╢ ║ Violation │ valid-oauth2-redirection-urls ║
╟───────────┼───────────────────────────────────╢ ║ Warning │ unknown-security-scheme ║
╟───────────┼───────────────────────────────────╢ ║ Warning │ oauth1-deprecated ║
╚═══════════╧═══════════════════════════════════╝

## governance:ruleset:init

`> governance:ruleset:init [flags] <schema>`

Initializes a ruleset based on the data schema passed in the `schema` parameter.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--types &lt;types&gt;</code></p></div></div></td><td><div><div><p>The <code>types</code> flag gives the target types to export as rules. You can use the <code>governance:api:inspect</code> command to identify the types to specify for this flag. See <a href="#governance-api-inspect">governance:api:inspect</a>.</p></div></div></td></tr><tr><td><div><div><p><code>--name &lt;name&gt;</code></p></div></div></td><td><div><div><p>The <code>name</code> flag is the name of the ruleset. This defaults to <code>GeneratedRuleset</code>.</p></div></div></td></tr></tbody></table>

**Example command:**

```copy
anypoint-cli-v4 governance:ruleset:init --types patientmultipleBirthBoolean,patientBundle,patientmultipleBirthInteger --name=my-ruleset mydataschema
```

## governance:ruleset:properties

`> governance:ruleset:properties [flags] <targetClass>`

Lists the properties and their types for the target class specified in `targetClass`. Property types
are `scalar`, `node`, `scalarArray`, `nodeArray`, or `dynamic`. For node types, the range (target
class) is also shown. Use the `governance:ruleset:classes` command to see available target classes.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example commands:**

```copy
anypoint-cli-v4 governance:ruleset:properties apiContract.Operation

anypoint-cli-v4 governance:ruleset:properties mcp.Tool
```

## governance:ruleset:resolve

`> governance:ruleset:resolve [flags] <term>`

Resolves the user-facing term specified in `term` to its canonical target class and property path.
Matching is fuzzy: case-insensitive, ignoring spaces, dashes, and underscores.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example commands:**

```copy
anypoint-cli-v4 governance:ruleset:resolve consumerUrl

anypoint-cli-v4 governance:ruleset:resolve rate-limit-policy
```

## governance:ruleset:simplify

`> governance:ruleset:simplify [flags] <ruleset>`

Simplifies the ruleset YAML file specified in `ruleset` by flattening nested property paths and
removing redundant logical wrappers. The command lists the simplifications applied and then prints
the simplified ruleset YAML to standard output.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example command:**

```copy
anypoint-cli-v4 governance:ruleset:simplify my-ruleset.yaml
```

## governance:ruleset:validate

`> governance:ruleset:validate [flags] <governance-ruleset>`

Validates the ruleset definitions passed using the `governance-ruleset` parameter. You can pass one
of the following as the `governance-ruleset` parameter:

- A ruleset definition YAML file

- A ZIP file that contains an API project with an `exchange.json` file that specifies the ruleset as
  the main file

- A folder that contains an API project with an `exchange.json` file that specifies the ruleset as
  the main file

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example commands:**

```copy
anypoint-cli-v4 governance:ruleset:validate ~/myrulesetfolder/myruleset.yaml

anypoint-cli-v4 governance:ruleset:validate ~/myrulesetfolder/myruleset.zip

anypoint-cli-v4 governance:ruleset:validate ~/myrulesetfolder/myrulesetfolder
```

**Example output for a valid ruleset:**

Ruleset User/myuser/myrulesetfolder/myruleset.yaml Ruleset conforms with Dialect

**Example output for a nonvalid ruleset:**

Ruleset does not conform with Dialect ModelId: file:///Users/myuser/myrulesetfolder/prof-1-bad.yaml
Profile: Validation Profile 1.0 Conforms: false Number of results: 1

Level: Violation

- Constraint:
  http://a.ml/amf/default\_document#/declarations/profileNode\_profile\_required\_validation
  Message: Property 'profile' is mandatory Severity: Violation Target:
  file:///Users/myuser/myrulesetfolder/prof-1-bad.yaml#/encodes Property: http://schema.org/name
  Range: \[(3,0)-(11,19)\] Location: file:///Users/myuser/myrulesetfolder/prof-1-bad.yaml

## governance:ruleset:validate-authoring

`> governance:ruleset:validate-authoring [flags] <ruleset>`

Validates the ruleset YAML file specified in `ruleset` against the authoring model, checking target
classes, property paths, constraint compatibility, and severity assignments. Prints diagnostics with
line numbers. The command exits with code `1` if any errors are found; warnings and informational
messages do not cause a failure.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example command:**

```copy
anypoint-cli-v4 governance:ruleset:validate-authoring my-ruleset.yaml
```

## governance:ruleset:version

`> governance:ruleset:version`

Shows the governance ruleset tooling version.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

**Example command:**

```copy
anypoint-cli-v4 governance:ruleset:version
```

### Get Exchange Asset Identifiers

To get the full asset identifier (group ID/asset ID/version) for Exchange assets:

- If you are using Anypoint CLI, run the `exchange:asset:list` command.

- If you are using the Anypoint Platform web UI, select the asset in Exchange and copy the group ID
  and asset ID from the URL. Then, add the version node for the version you are viewing. For
  example, the asset identifier for the OpenAPI Best Practices ruleset in Exchange is
  `68ef9520-24e9-4cf2-b2f5-620025690913/open-api-best-practices/1.0.1`.

<!-- document id=8777dbcd98a06cf83b7a9a83a2deed77e5ba8e8f99e2345c469bc47501415349 url=/mulesoft/current/en-us/anypoint-cli/3.x/api-mgr.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for API Manager

> 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="#api-mgr-alert-add">api-mgr alert add</a></p></div></div></td><td><div><div><p>Creates an API instance alert</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-alert-list">api-mgr alert list</a></p></div></div></td><td><div><div><p>Lists alerts for an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-change-specification">api-mgr api change-specification</a></p></div></div></td><td><div><div><p>Changes the asset version for an API instance by choosing a new version from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-classify">api-mgr api classify</a></p></div></div></td><td><div><div><p>Classifies an API instance in a given environment</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-delete">api-mgr api delete</a></p></div></div></td><td><div><div><p>Deletes an API</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-deploy">api-mgr api deploy</a></p></div></div></td><td><div><div><p>Deploys an API to CloudHub, hybrid server, or Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-deprecate">api-mgr api deprecate</a></p></div></div></td><td><div><div><p>Deprecates an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-describe">api-mgr api describe</a></p></div></div></td><td><div><div><p>Shows details of an API</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-download-proxy">api-mgr api download-proxy</a></p></div></div></td><td><div><div><p>Downloads the API proxy ZIP file to a local directory</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-edit">api-mgr api edit</a></p></div></div></td><td><div><div><p>Edits an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-list">api-mgr api list</a></p></div></div></td><td><div><div><p>Lists all APIs in API Manager 2.x</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-manage">api-mgr api manage</a></p></div></div></td><td><div><div><p>Manages a new API, API version, or new API instance with an asset from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-promote">api-mgr api promote</a></p></div></div></td><td><div><div><p>Promotes an API instance from source environment</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-redeploy">api-mgr api redeploy</a></p></div></div></td><td><div><div><p>Redeploys an API to CloudHub, Hybrid server, or Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-undeprecate">api-mgr api undeprecate</a></p></div></div></td><td><div><div><p>Undeprecates an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-contract-delete">api-mgr contract delete</a></p></div></div></td><td><div><div><p>Deletes a given API contract</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-contract-list">api-mgr contract list</a></p></div></div></td><td><div><div><p>Lists all contracts to a given API instance.</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-apply">api-mgr policy apply</a></p></div></div></td><td><div><div><p>Applies a policy to a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-describe">api-mgr policy describe</a></p></div></div></td><td><div><div><p>Shows the description and available configuration properties of a given policy template</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-disable">api-mgr policy disable</a></p></div></div></td><td><div><div><p>Disables policy from a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-edit">api-mgr policy edit</a></p></div></div></td><td><div><div><p>Edits the policy configuration of a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-enable">api-mgr policy enable</a></p></div></div></td><td><div><div><p>Enables a policy on a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-list">api-mgr policy list</a></p></div></div></td><td><div><div><p>Lists policies</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-remove">api-mgr policy remove</a></p></div></div></td><td><div><div><p>Removes a policy from a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-tier-add">api-mgr tier add</a></p></div></div></td><td><div><div><p>Creates an SLA tier</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-tier-copy">api-mgr tier copy</a></p></div></div></td><td><div><div><p>Copies an SLA tier from source to a target API Instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-tier-delete">api-mgr tier delete</a></p></div></div></td><td><div><div><p>Deletes an SLA tier from an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-tier-list">api-mgr tier list</a></p></div></div></td><td><div><div><p>Lists the SLA tiers of an API instance</p></div></div></td></tr></tbody></table>

## api-mgr alert add

\> api-mgr alert add \[options\] <apiInstanceId> <name>

This command creates an API instance alert with the name passed in `name` for the API Instance Id
passed in `<apiInstanceId>`.

Besides 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><code>enabled</code></p></div></div></td><td><div><div><p>Sets whether the alert should be enabled or not.<br>Possible values are <code>true</code> or <code>false</code>.</p></div></div></td></tr><tr><td><div><div><p><code>severity &lt;val&gt;</code></p></div></div></td><td><div><div><p>Alert severity.<br>Supported values: <code>Info</code>, <code>Warning</code>, <code>Critical</code>.</p></div></div></td></tr><tr><td><div><div><p><code>type &lt;val&gt;</code></p></div></div></td><td><div><div><p>Alert type/condition.<br>Supported values: <code>request-count</code>, <code>response-code</code>, <code>policy-violation</code>, <code>response-time</code></p></div></div></td></tr><tr><td><div><div><p><code>operator &lt;val&gt;</code></p></div></div></td><td><div><div><p>Condition operator explaining values relation to threshold.<br>Supported values: gt, lt, eq</p></div></div></td></tr><tr><td><div><div><p><code>threshold &lt;num&gt;</code></p></div></div></td><td><div><div><p>Condition occurrences threshold number.</p></div></div></td></tr><tr><td><div><div><p><code>periods &lt;num&gt;</code></p></div></div></td><td><div><div><p>Number of consecutive periods condition should occur for.</p></div></div></td></tr><tr><td><div><div><p><code>duration &lt;num&gt;</code></p></div></div></td><td><div><div><p>Condition occurrence period duration.</p></div></div></td></tr><tr><td><div><div><p><code>durationUnit &lt;val&gt;</code></p></div></div></td><td><div><div><p>Condition occurrence period duration unit.<br>Supported values: days, hours, minutes.</p></div></div></td></tr><tr><td><div><div><p><code>recipient [username]</code></p></div></div></td><td><div><div><p>Username to send alert notification to.<br>You can pass this option multiple times to specify multiple usernames.</p></div></div></td></tr><tr><td><div><div><p><code>email [emailAddress]</code></p></div></div></td><td><div><div><p>Email to send alert notification to.<br>You can pass this option multiple times to specify multiple emails.</p></div></div></td></tr><tr><td><div><div><p><code>responseTime [num]</code></p></div></div></td><td><div><div><p>Response time to trigger <code>response-time</code> alert type.</p></div></div></td></tr><tr><td><div><div><p><code>responseCode [code]</code></p></div></div></td><td><div><div><p>Response codes to trigger <code>response-code</code> alert type.<br>You can pass this option multiple times to specify multiple codes.</p></div></div></td></tr><tr><td><div><div><p><code>policyId [num]</code></p></div></div></td><td><div><div><p>ID of a policy applied to API instance to trigger <code>response-code</code> alert type.</p></div></div></td></tr></tbody></table>

## api-mgr alert list

\> api-mgr alert list \[options\] <apiInstanceId>

Lists alerts for the API instance passed in `<apiInstanceId>`.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the amount of APIs passed</p></div></div></td><td><div><div><p><code>api-mgr alert list --offset 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--sort</code></p></div></div></td><td><div><div><p>Sorts the results in the field name passed<br>Supported values are: <code>id</code>, <code>name</code>, <code>createdDate</code>, and <code>updatedDate</code></p></div></div></td><td><div><div><p><code>api-mgr alert list --sort updatedDate</code></p></div></div></td></tr></tbody></table>

## api-mgr api change-specification

\> api-mgr api change-specification \[options\] <apiInstanceId> <assetVersion>

Changes the asset version for the API instance passed in `<apiInstanceId`, by choosing a new version
from Exchange passed in `<assetVersion>`.

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

## api-mgr api classify

\> api-mgr api classify \[options\] <destEnvName> <apiInstanceId>

Classifies the API instance passed in `<apiInstanceId>` in the environment passed in
`<destEnvName>`.

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

## api-mgr api delete

\> api-mgr api delete \[options\] <apiInstanceId>

This command deletes the API instance passed in `<apiInstanceId>`.

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

## api-mgr api deploy

\> api-mgr api deploy \[options\] <apiInstanceId>

This command deploys the API instance passed in <apiInstanceId> to the deployment target specified
using the options described below.

> [!NOTE] This command is only supported for endpoints with proxy.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>target &lt;id&gt;</code></p></div></div></td><td><div><div><p>Hybrid or RTF deployment target ID.<br></p></div></div></td><td><div><div><p><code>api-mgr api deploy --target 1598794 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>applicationName &lt;name&gt;</code></p></div></div></td><td><div><div><p>Application name</p></div></div></td><td><div><div><p><code>api-mgr api deploy --applicationName myMuleApp 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>environmentName &lt;name&gt;</code></p></div></div></td><td><div><div><p>Target environment name. Should only be used when deploying APIs from unclassified environments.</p></div></div></td><td><div><div><p><code>api-mgr api deploy --environmentName TestEnv 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>gatewayVersion &lt;version&gt;</code></p></div></div></td><td><div><div><p>The CloudHub Gateway version</p></div></div></td><td><div><div><p><code>api-mgr api deploy --gatewayVersion: 9.9.9.9 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>overwrite</code></p></div></div></td><td><div><div><p>Update application if it exists.<br>It takes <code>true</code> or <code>false</code> values.</p></div></div></td><td><div><div><p><code>api-mgr api deploy --overwrite: true 643404</code></p></div></div></td></tr></tbody></table>

## api-mgr api deprecate

\> api-mgr api deprecate \[options\] <apiInstanceId>

Deprecates the API instance passed in `<apiInstanceId>`.

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

## api-mgr api describe

\> api-mgr api describe \[options\] <apiInstanceId>

Shows details of the API Instance passed in `<apiInstanceId>`.

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

## api-mgr api download-proxy

\> api-mgr api download-proxy \[options\] <apiInstanceId> <targetPath>

This command downloads the API proxy ZIP file of the API Instance passed in `<apiInstanceId>` to a
local directory specified in `<targetPath>`.

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes a
`gatewayVersion` option to specify the gateway version you want to download. For example:
`api-mgr api download-proxy --gatewayVersion: 4.0.1 643404 /tmp/`

## api-mgr api edit

\> api-mgr api edit \[options\] <apiInstanceId>

Edits the API instance passed in `<apiInstanceId>`.  
Besides 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><code>-p, --withProxy</code></p></div></div></td><td><div><div><p>Indicates whether the endpoint should use a proxy.<br>This option takes <code>true</code> or <code>false</code> values.</p></div></div></td></tr><tr><td><div><div><p><code>-r, --referencesUserDomain</code></p></div></div></td><td><div><div><p>Indicates whether a proxy should reference a user domain.<br>This option takes <code>true</code> or <code>false</code> values.</p></div></div></td></tr><tr><td><div><div><p><code>-m, --muleVersion4OrAbove</code></p></div></div></td><td><div><div><p>Indicates whether you are managing this API in Mule 4 or above.<br>This option takes <code>true</code> or <code>false</code> values.</p></div></div></td></tr><tr><td><div><div><p><code>--deploymentType &lt;value&gt;</code></p></div></div></td><td><div><div><p>Deployment type.<br>Supported values are <code>cloudhub</code>, <code>hybrid</code>, or <code>rtf</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--endpointUri &lt;value&gt;</code></p></div></div></td><td><div><div><p>Consumer endpoint URI.</p></div></div></td></tr><tr><td><div><div><p><code>--uri &lt;value&gt;</code></p></div></div></td><td><div><div><p>Implementation URI.</p></div></div></td></tr><tr><td><div><div><p><code>--scheme &lt;value&gt;</code></p></div></div></td><td><div><div><p>Proxy scheme.<br>Supported values are <code>http</code>, or <code>https</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--port &lt;value&gt;</code></p></div></div></td><td><div><div><p>Proxy port.</p></div></div></td></tr><tr><td><div><div><p><code>--path &lt;value&gt;</code></p></div></div></td><td><div><div><p>Proxy path.</p></div></div></td></tr><tr><td><div><div><p><code>--responseTimeout &lt;value&gt;</code></p></div></div></td><td><div><div><p>Your maximum response timeout.</p></div></div></td></tr><tr><td><div><div><p><code>--apiInstanceLabel &lt;value&gt;</code></p></div></div></td><td><div><div><p>(Optional) API instance label.</p></div></div></td></tr><tr><td><div><div><p><code>--serviceName &lt;value&gt;</code></p></div></div></td><td><div><div><p>WSDL service name.</p></div></div></td></tr><tr><td><div><div><p><code>--serviceNamespace &lt;value&gt;</code></p></div></div></td><td><div><div><p>WSDL service namespace.</p></div></div></td></tr><tr><td><div><div><p><code>--servicePort &lt;value&gt;</code></p></div></div></td><td><div><div><p>WSDL service port.</p></div></div></td></tr></tbody></table>

## api-mgr api list

\> api-mgr api list \[options\]

Lists all APIs in API Manager 2.x.

Besides 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><code>--assetId &lt;value&gt;</code></p></div></div></td><td><div><div><p>Asset ID by which filter results.</p></div></div></td></tr><tr><td><div><div><p><code>--apiVersion &lt;value&gt;</code></p></div></div></td><td><div><div><p>API version by which filter results.</p></div></div></td></tr><tr><td><div><div><p><code>--instanceLabel &lt;value&gt;</code></p></div></div></td><td><div><div><p>API instance label by which filter results.</p></div></div></td></tr><tr><td><div><div><p><code>--limit &lt;num&gt;</code></p></div></div></td><td><div><div><p>Number of results to retrieve.</p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the amount of APIs passed</p></div></div></td></tr><tr><td><div><div><p><code>--sort</code><br>Supported values are: <code>id</code>, <code>name</code>, <code>createdDate</code>, and <code>updatedDate</code></p></div></div></td><td><div><div><p>Sorts the results in the field name passed</p></div></div></td></tr></tbody></table>

## api-mgr api manage

\> api-mgr api manage \[options\] <assetId> <assetVersion>

Manages a new API, API version, or new API instance with the Exchange asset passed in `<assetId>`,
and the version passed in `<assetVersion>`.

Besides 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><code>--type &lt;value&gt;</code></p></div></div></td><td><div><div><p>Endpoint type.<br>Accepted values are <code>http</code>, <code>raml</code>, or <code>wsdl</code>.</p></div></div></td></tr><tr><td><div><div><p><code>-p, --withProxy</code></p></div></div></td><td><div><div><p>Indicates whether the endpoint should use a proxy.<br>This option takes <code>true</code> or <code>false</code> values.</p></div></div></td></tr><tr><td><div><div><p><code>-r, --referencesUserDomain</code></p></div></div></td><td><div><div><p>Indicates whether a proxy should reference a user domain.<br>This option takes <code>true</code> or <code>false</code> values.</p></div></div></td></tr><tr><td><div><div><p><code>-m, --muleVersion4OrAbove</code></p></div></div></td><td><div><div><p>Indicates whether you are managing this API in Mule 4 or above.<br>This option takes <code>true</code> or <code>false</code> values.</p></div></div></td></tr><tr><td><div><div><p><code>--deploymentType &lt;value&gt;</code></p></div></div></td><td><div><div><p>Deployment type.<br>Supported values are <code>cloudhub</code>, <code>hybrid</code>, or <code>rtf</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--endpointUri &lt;value&gt;</code></p></div></div></td><td><div><div><p>Consumer endpoint URI.</p></div></div></td></tr><tr><td><div><div><p><code>--uri &lt;value&gt;</code></p></div></div></td><td><div><div><p>Implementation URI.</p></div></div></td></tr><tr><td><div><div><p><code>--scheme &lt;value&gt;</code></p></div></div></td><td><div><div><p>Proxy scheme.<br>Supported values are <code>http</code>, or <code>https</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--port &lt;value&gt;</code></p></div></div></td><td><div><div><p>Proxy port.</p></div></div></td></tr><tr><td><div><div><p><code>--path &lt;value&gt;</code></p></div></div></td><td><div><div><p>Proxy path.</p></div></div></td></tr><tr><td><div><div><p><code>--responseTimeout &lt;value&gt;</code></p></div></div></td><td><div><div><p>Response timeout.</p></div></div></td></tr><tr><td><div><div><p><code>--apiInstanceLabel &lt;value&gt;</code></p></div></div></td><td><div><div><p>(Optional) API instance label.</p></div></div></td></tr><tr><td><div><div><p><code>--serviceName &lt;value&gt;</code></p></div></div></td><td><div><div><p>WSDL service name.</p></div></div></td></tr><tr><td><div><div><p><code>--serviceNamespace &lt;value&gt;</code></p></div></div></td><td><div><div><p>WSDL service namespace.</p></div></div></td></tr><tr><td><div><div><p><code>--servicePort &lt;value&gt;</code></p></div></div></td><td><div><div><p>WSDL service port.</p></div></div></td></tr></tbody></table>

## api-mgr api promote

\> api-mgr api promote \[options\] <apiInstanceId> <sourceEnvId>

Promotes the API instance passed in `<apiInstanceId>` from the source environment in
`<sourceEnvId>`.

Besides 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><code>-a, --copyAlerts</code></p></div></div></td><td><div><div><p>Indicates whether to copy alerts.<br>This option takes <code>true</code> or <code>false</code> values. Default Value is <code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>-p, --copyPolicies</code></p></div></div></td><td><div><div><p>Indicates whether to copy policies.<br>This option takes <code>true</code> or <code>false</code> values. Default Value is <code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>-t, --copyTiers</code></p></div></div></td><td><div><div><p>Indicates whether to copy tiers.<br>This option takes <code>true</code> or <code>false</code> values. Default Value is <code>true</code></p></div></div></td></tr></tbody></table>

## api-mgr api redeploy

\> api-mgr api redeploy \[options\] <apiInstanceId>

Redeploys the API Instance passed in `<apiInstanceId>` to the deployment target set up in the
options described below.

Besides 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><code>--target &lt;id&gt;</code></p></div></div></td><td><div><div><p>Hybrid or RTF deployment target ID.</p></div></div></td></tr><tr><td><div><div><p><code>--applicationName &lt;name&gt;</code></p></div></div></td><td><div><div><p>Application name.</p></div></div></td></tr><tr><td><div><div><p><code>--environmentName &lt;name&gt;</code></p></div></div></td><td><div><div><p>Target environment name.<br>Must be provided to redeploy APIs from unclassified environments.</p></div></div></td></tr><tr><td><div><div><p><code>--gatewayVersion &lt;version&gt;</code></p></div></div></td><td><div><div><p>CloudHub Gateway version.</p></div></div></td></tr><tr><td><div><div><p><code>--overwrite</code></p></div></div></td><td><div><div><p>Update application if exists.<br>This option takes <code>true</code> or <code>false</code> values. Default Value is <code>true</code></p></div></div></td></tr></tbody></table>

## api-mgr api undeprecate

\> api-mgr api undeprecate \[options\] <apiInstanceId>

Undeprecates the API instance passed in `<apiInstanceId>`.

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

## api-mgr contract delete

\> api-mgr contract delete \[options\] <apiInstanceId> <clientId>

This command deletes the contract between the API Instance passed in `<apiInstanceId>`, and the
client passed in `<clientId>`.

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

## api-mgr contract list

\> api-mgr contract list \[options\] <apiInstanceId> \[searchText\]

Lists all contracts of the API passed in `<apiInstanceId>`.

> [!TIP] You can specify keywords in searchText to limit results to APIs containing those specific
> keywords.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Number of results to retrieve</p></div></div></td><td><div><div><p><code>exchange asset list --limit 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the amount of APIs passed</p></div></div></td><td><div><div><p><code>api-mgr contract list --offset 3 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--sort</code></p></div></div></td><td><div><div><p>Sorts the results in the field name passed<br>Supported values are: <code>id</code>, <code>name</code>, <code>createdDate</code>, and <code>updatedDate</code></p></div></div></td><td><div><div><p><code>api-mgr contract list --sort createdDate</code></p></div></div></td></tr></tbody></table>

## api-mgr policy apply

\> api-mgr policy apply \[options\] <apiInstanceId> <policyId>

Applies the policy passed in `<policyId>` to the API instance passed in `<apiInstanceId>`.

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--policyVersion &lt;value&gt;</code></p></div></div></td><td><div><div><p>Mule 4 policy version.</p></div></div></td></tr><tr><td><div><div><p><code>--groupId &lt;value&gt;</code></p></div></div></td><td><div><div><p>Mule 4 policy group ID.<br>If no value is provided, this value defaults to MuleSoft group ID.</p></div></div></td></tr><tr><td><div><div><p><code>-c, --config [configJSON]</code></p></div></div></td><td><div><div><p>Pass the configuration data as a JSON string.<br>For example, <code>api-mgr policy apply -c '{"property": "value"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--configFile [file]</code></p></div></div></td><td><div><div><p>Pass the configuration data as a file.<br>For example, <code>api-mgr policy apply --configFile ./config.json</code></p></div></div></td></tr><tr><td><div><div><p><code>-p, --pointcut [dataJSON]</code></p></div></div></td><td><div><div><p>Pass pointcut data as JSON strings.<br>For example <code>api-mgr policy apply (…​) -p '[{"methodRegex":"GET\|PUT","uriTemplateRegex":"/users*"}]'</code></p></div></div></td></tr></tbody></table>

The following example defines a rate limit of one request every ten seconds:

{ "rateLimits": \[{ "maximumRequests": 1, "timePeriodInMilliseconds": 10000 }\], "clusterizable":
true, "exposeHeaders": false }

## api-mgr policy describe

\> api-mgr policy describe \[options\] <policyId>

This command shows the description and available configuration properties of the policy passed in
`<policyId>`.

Besides 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><code>--policyVersion &lt;value&gt;</code></p></div></div></td><td><div><div><p>Mule4 policy version.</p></div></div></td></tr><tr><td><div><div><p><code>--groupId &lt;value&gt;</code></p></div></div></td><td><div><div><p>Mule4 policy group ID.<br>Defaults to MuleSoft group ID when not provided.</p></div></div></td></tr></tbody></table>

## api-mgr policy disable

\> api-mgr policy disable \[options\] <apiInstanceId> <policyId>

This command disables the policy passed in `<policyId>` from the API instance passed in
`<apiInstanceId>`.

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

## api-mgr policy edit

\> api-mgr policy edit \[options\] <apiInstanceId> <policyId>

This command edits the policy configuration passed in `<policyId>` of the API Instance passed in
`<apiInstanceId>`.

Besides 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><code>-c, --config [configJSON</code>]</p></div></div></td><td><div><div><p>Pass the configuration data as a JSON string.<br>For example, <code>api-mgr policy apply -c '{"property": "value"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>-p, --pointcut [dataJSON]</code></p></div></div></td><td><div><div><p>Pass pointcut data as JSON strings.<br>For example <code>api-mgr policy apply (…​) -p '[{"methodRegex":"GET\|PUT","uriTemplateRegex":"/users*"}]'</code></p></div></div></td></tr></tbody></table>

## api-mgr policy enable

\> api-mgr policy enable \[options\] <apiInstanceId> <policyId>

This command enables the policy passed in `<policyId>` for the API Instance passed in
`<apiInstanceId>`.

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

## api-mgr policy list

\> api-mgr policy list \[options\] \[apiInstanceId\]

This command lists all policies for all APIs in API Manager 2.x.  
When the `[apiInstanceId]` parameter is specified, this command lists the policies applied to that
API instance.

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes
the `-m, --muleVersion4OrAbove` option which takes `true` or `false` values.

## api-mgr policy remove

\> api-mgr policy remove \[options\] <apiInstanceId> <policyId>

This command removes the policy specified in `<policyId>` from the API instance passed in
`<apiInstanceId>`.

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

## api-mgr tier add

\> api-mgr tier add \[options\] <apiInstanceId>

This command creates an SLA tier for the API instance passed in `<apiInstanceId>`.

Besides 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><code>-a, --autoApprove</code></p></div></div></td><td><div><div><p>Indicates whether the SAL tier should be auto-approved.<br>This command only takes <code>true</code> or <code>false</code> values.</p></div></div></td></tr><tr><td><div><div><p><code>--name &lt;value&gt;</code></p></div></div></td><td><div><div><p>Tier name</p></div></div></td></tr><tr><td><div><div><p><code>--description &lt;value&gt;</code></p></div></div></td><td><div><div><p>Tier description</p></div></div></td></tr><tr><td><div><div><p><code>-l, --limit &lt;value&gt;</code></p></div></div></td><td><div><div><p>Single instance of an SLA tier limit in the form <code>--limit A,B,C</code> where:</p></div><div><ul><li><p><code>A</code> is a boolean indicating whether or not this limit should be visible.</p></li><li><p><code>B</code> is a number of requests per "C" time period.</p></li><li><p><code>C</code> is the time period unit. Time period options are:</p><div><ul><li><p><code>ms</code>(millisecond)</p></li><li><p><code>sec</code>(second)</p></li><li><p><code>min</code>(minute)</p></li><li><p><code>hr</code>(hour)</p></li><li><p><code>d</code>(day)</p></li><li><p><code>wk</code>(week)</p></li><li><p><code>mo</code>(month)</p></li><li><p><code>yr</code>(year)</p></li></ul></div></li></ul></div><div><p>For example: <code>--limit true,100,min</code> is a visible limit of 100 requests per minute.<br></p></div><div><div data-type="TIP">To create multiple limits, you can provide multiple <code>--limit</code> options.<br>For example: <code>-l true,100,sec -l false,20,min</code></div></div></div></td></tr></tbody></table>

## api-mgr tier copy

\> api-mgr tier copy \[options\] <sourceAPIInstanceId> <targetAPIInstanceId>

This command copies the SLA tier from the API instance passed in `<sourceAPIInstanceId>` to the API
instance Id passed in `<targetAPIInstanceId>`.

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

## api-mgr tier delete

\> api-mgr tier delete \[options\] <apiInstanceId> <tierId>

This command deletes the SLA tier passed in `<tierId>` from API instance passed in
`<apiInstanceId>`.

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

## api-mgr tier list

\> api-mgr tier list \[options\] <apiInstanceId> \[searchText\]

This command lists the SLA tiers of the API instance passed in `<apiInstanceId>`.

Besides 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>Example</p></div></div></td><td><div><div><p><code>--limit</code></p></div></div></td></tr><tr><td><div><div><p>Number of results to retrieve</p></div></div></td><td><div><div><p><code>api-mgr tier list --limit 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the amount of APIs passed</p></div></div></td></tr><tr><td><div><div><p><code>api-mgr tier list --offset 3</code></p></div></div></td><td><div><div><p><code>--sort</code></p></div></div></td></tr><tr><td><div><div><p>Sorts the results in the field name passed<br>Supported values are: <code>id</code>, <code>name</code>, <code>createdDate</code>, and <code>updatedDate</code></p></div></div></td><td><div><div><p><code>api-mgr tier list --sort id</code></p></div></div></td></tr></tbody></table>

<!-- document id=a89666bc6d68c75d1acf3a05bbc5094d5374c8defebeceab79ef480855203389 url=/mulesoft/current/en-us/anypoint-cli/latest/api-mgr.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for API Manager

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

Use the `api-mgr` commands to automate your API Manager processes. For more information about how to
use these commands, refer to the [API Manager documentation](https://docs.mulesoft.com/api-manager/latest/).

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#api-mgr-alert-add">api-mgr:alert:add</a></p></div></div></td><td><div><div><p>Creates an API instance alert</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-alert-list">api-mgr:alert:list</a></p></div></div></td><td><div><div><p>Lists alerts for an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-autodiscovery">api-mgr:api:autodiscovery</a></p></div></div></td><td><div><div><p>Lists the autodiscovery properties</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-change-specification">api-mgr:api:change-specification</a></p></div></div></td><td><div><div><p>Changes the asset version for an API instance by choosing a new version from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-classify">api-mgr:api:classify</a></p></div></div></td><td><div><div><p>Classifies an API instance in a given environment</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-delete">api-mgr:api:delete</a></p></div></div></td><td><div><div><p>Deletes an API</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-deploy">api-mgr:api:deploy</a></p></div></div></td><td><div><div><p>Deploys an API to CloudHub, CloudHub2, Hybrid Server, or Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-deprecate">api-mgr:api:deprecate</a></p></div></div></td><td><div><div><p>Deprecates an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-describe">api-mgr:api:describe</a></p></div></div></td><td><div><div><p>Shows details of an API</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-download-proxy">api-mgr:api:download-proxy</a></p></div></div></td><td><div><div><p>Downloads the API proxy ZIP file to a local directory</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-edit">api-mgr:api:edit</a></p></div></div></td><td><div><div><p>Edits an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-list">api-mgr:api:list</a></p></div></div></td><td><div><div><p>Lists all APIs in API Manager 2.x</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-manage">api-mgr:api:manage</a></p></div></div></td><td><div><div><p>Manages a new API, API version, or new API instance with an asset from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-promote">api-mgr:api:promote</a></p></div></div></td><td><div><div><p>Promotes an API instance from source environment</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-redeploy">api-mgr:api:redeploy</a></p></div></div></td><td><div><div><p>Redeploys an API to CloudHub, CloudHub2, Hybrid Server, or Runtime Fabric</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-api-undeprecate">api-mgr:api:undeprecate</a></p></div></div></td><td><div><div><p>Undeprecates an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-application-add-owner">api-mgr:application:add-owner</a></p></div></div></td><td><div><div><p>Adds an owner to a client application</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-application-import">api-mgr:application:import</a></p></div></div></td><td><div><div><p>Imports a client application from an external client identity provider</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-application-possible-owners-list">api-mgr:application:possible-owners-list</a></p></div></div></td><td><div><div><p>Lists possible owners for a client application in the current organization</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-client-provider-list-importable">api-mgr:client-provider:list-importable</a></p></div></div></td><td><div><div><p>Lists client identity providers with import enabled in the current organization</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-contract-delete">api-mgr:contract:delete</a></p></div></div></td><td><div><div><p>Deletes a given API contract</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-contract-list">api-mgr:contract:list</a></p></div></div></td><td><div><div><p>Lists all contracts to a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-apply">api-mgr:policy:apply</a></p></div></div></td><td><div><div><p>Applies a policy to a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-describe">api-mgr:policy:describe</a></p></div></div></td><td><div><div><p>Shows the description and available configuration properties of a given policy template</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-disable">api-mgr:policy:disable</a></p></div></div></td><td><div><div><p>Disables policy from a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-edit">api-mgr:policy:edit</a></p></div></div></td><td><div><div><p>Edits the policy configuration of a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-enable">api-mgr:policy:enable</a></p></div></div></td><td><div><div><p>Enables a policy on a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-list">api-mgr:policy:list</a></p></div></div></td><td><div><div><p>Lists policies</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-policy-remove">api-mgr:policy:remove</a></p></div></div></td><td><div><div><p>Removes a policy from a given API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-tier-add">api-mgr:tier:add</a></p></div></div></td><td><div><div><p>Creates an SLA tier</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-tier-copy">api-mgr:tier:copy</a></p></div></div></td><td><div><div><p>Copies an SLA tier from source to a target API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-tier-delete">api-mgr:tier:delete</a></p></div></div></td><td><div><div><p>Deletes an SLA tier from an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-tier-list">api-mgr:tier:list</a></p></div></div></td><td><div><div><p>Lists the SLA tiers of an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-upstream-add">api-mgr:upstream:add</a></p></div></div></td><td><div><div><p>Creates an upstream for an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-upstream-bulk-edit">api-mgr:upstream:bulk-edit</a></p></div></div></td><td><div><div><p>Bulk edits the TLS context for all upstreams of an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-upstream-delete">api-mgr:upstream:delete</a></p></div></div></td><td><div><div><p>Deletes an upstream from an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-upstream-edit">api-mgr:upstream:edit</a></p></div></div></td><td><div><div><p>Edits an upstream of an API instance</p></div></div></td></tr><tr><td><div><div><p><a href="#api-mgr-upstream-list">api-mgr:upstream:list</a></p></div></div></td><td><div><div><p>Lists all upstreams for an API instance</p></div></div></td></tr></tbody></table>

## api-mgr:alert:add

\> api-mgr:alert:add <apiInstanceId> <name> \[flags\]

Creates an API instance alert with the name passed in `name` for the API instance ID passed in
`<apiInstanceId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--duration</code></p></div></div></td><td><div><div><p>Condition occurrence period duration.</p></div></div></td><td><div><div><p><code>--duration 60</code></p></div></div></td></tr><tr><td><div><div><p><code>--durationUnit</code></p></div></div></td><td><div><div><p>Condition occurrence period duration unit.<br>Supported values: <code>days</code>, <code>hours</code>, and <code>minutes</code>.</p></div></div></td><td><div><div><p><code>--durationUnit minutes</code></p></div></div></td></tr><tr><td><div><div><p><code>--email</code></p></div></div></td><td><div><div><p>Email to send alert notification to.<br>Pass this flag multiple times to specify multiple emails.</p></div></div></td><td><div><div><p><code>--email <a href="mailto:example@mulesoft.com">example@mulesoft.com</a></code></p></div></div></td></tr><tr><td><div><div><p><code>--enabled</code></p></div></div></td><td><div><div><p>Sets whether the alert is enabled. Include the flag to enable the alert.</p></div></div></td><td><div><div><p><code>--enabled</code></p></div></div></td></tr><tr><td><div><div><p><code>--operator</code></p></div></div></td><td><div><div><p>Condition operator that explains values in relation to threshold.<br>Supported values: <code>gt</code>, <code>lt</code>, <code>eq</code>.</p></div></div></td><td><div><div><p><code>--operator gt</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--periods</code></p></div></div></td><td><div><div><p>Number of consecutive periods condition should occur for.</p></div></div></td><td><div><div><p><code>--periods 34</code></p></div></div></td></tr><tr><td><div><div><p><code>--policyId</code></p></div></div></td><td><div><div><p>ID of a policy applied to the API instance that triggers a <code>policy-violation</code> alert type.</p></div></div></td><td><div><div><p><code>--policyId http-basic-authentication</code></p></div></div></td></tr><tr><td><div><div><p><code>--recipient</code></p></div></div></td><td><div><div><p>Username to send alert notification to.<br>Pass this flag multiple times to specify multiple usernames.</p></div></div></td><td><div><div><p><code>--recipient mulesoftuser</code></p></div></div></td></tr><tr><td><div><div><p><code>--responseCode</code></p></div></div></td><td><div><div><p>Response codes to trigger <code>response-code</code> alert type.<br>Pass this flag multiple times to specify multiple codes.</p></div></div></td><td><div><div><p><code>--responseCode 400</code></p></div></div></td></tr><tr><td><div><div><p><code>--responseTime</code></p></div></div></td><td><div><div><p>Response time to trigger <code>response-time</code> alert type.</p></div></div></td><td><div><div><p><code>--responseTime 60</code></p></div></div></td></tr><tr><td><div><div><p><code>--severity</code></p></div></div></td><td><div><div><p>Alert severity.<br>Supported values: <code>Info</code>, <code>Warning</code>, <code>Critical</code>.</p></div></div></td><td><div><div><p><code>--severity Critical</code></p></div></div></td></tr><tr><td><div><div><p><code>--threshold</code></p></div></div></td><td><div><div><p>Condition occurrences threshold number.</p></div></div></td><td><div><div><p><code>--threshold 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Alert type/condition.<br>Supported values: <code>request-count</code>, <code>response-code</code>, <code>policy-violation</code>, <code>response-time</code></p></div></div></td><td><div><div><p><code>--type response-code</code></p></div></div></td></tr></tbody></table>

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

## api-mgr:alert:list

\> api-mgr:alert:list \[flags\] <apiInstanceId>

Lists alerts for the API instance passed in `<apiInstanceId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Number of results to retrieve, default is 10 results</p></div></div></td><td><div><div><p><code>--limit 5</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the amount of APIs passed</p></div></div></td><td><div><div><p><code>--offset 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format<br>Supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--sort</code></p></div></div></td><td><div><div><p>Sorts the results in the field name passed<br>Supported values are: <code>id</code>, <code>name</code>, <code>createdDate</code>, and <code>updatedDate</code></p></div></div></td><td><div><div><p><code>--sort name</code></p></div></div></td></tr></tbody></table>

## api-mgr:api:autodiscovery

\> api-mgr:api:autodiscovery \[flags\] <apiInstanceId> <name>

This command lists the autodiscovery properties required for a gateway to track the API Instance Id
passed in `<apiInstanceId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--gatewayVersion</code></p></div></div></td><td><div><div><p>Specifies the gateway version to download</p></div></div></td><td><div><div><p><code>--gatewayVersion 4.0.1 643404 /tmp/</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format<br>Supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output table</code></p></div></div></td></tr></tbody></table>

## api-mgr:api:change-specification

\> api-mgr:api:change-specification \[flags\] <apiInstanceId> <assetVersion>

Changes the asset version for the API instance passed in `<apiInstanceId>` by choosing a new version
from Exchange passed in `<assetVersion>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:api:classify

\> api-mgr:api:classify \[flags\] <destEnvName> <apiInstanceId>

Classifies the API instance passed in `<apiInstanceId>` in the environment passed in
`<destEnvName>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:api:delete

\> api-mgr:api:delete \[flags\] <apiInstanceId>

Deletes the API instance passed in `<apiInstanceId>`. If the API instance is deployed, this command
undeploys the API instance before deleting it.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:api:deploy

\> api-mgr:api:deploy \[flags\] <apiInstanceId>

Deploys the API instance passed in '<apiInstanceId>' to the deployment target specified using the
flags described next. Deploy any undeployed API using this command regardless of whether it was
created using the API Manager CLI or API Manager UI.

> [!NOTE] This command is only supported for endpoints with proxy.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--applicationName</code></p></div></div></td><td><div><div><p>Application name</p></div></div></td><td><div><div><p><code>--applicationName myMuleApp 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--environmentName</code></p></div></div></td><td><div><div><p>Target environment name, only for when deploying API instances from unclassified environments</p></div></div></td><td><div><div><p><code>--environmentName TestEnv 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--gatewayVersion</code></p></div></div></td><td><div><div><p>The CloudHub Gateway version</p></div></div></td><td><div><div><p><code>--gatewayVersion: 9.9.9.9 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--javaVersion</code></p></div></div></td><td><div><div><p>Gateway Java version<br>This flag only works if the target flag was set as <code>RTF</code>, <code>CH</code>, or <code>CH2</code></p></div></div></td><td><div><div><p><code>--javaVersion 17 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--releaseChannel</code></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><br>This flag only works if the target flag was set as <code>RTF</code>, <code>CH</code>, or <code>CH2</code></p></div></div></td><td><div><div><p><code>--releaseChannel EDGE 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--overwrite</code></p></div></div></td><td><div><div><p>Update application if it exists<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--overwrite</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--target</code></p></div></div></td><td><div><div><p>Hybrid, RTF, CH, or CH2 deployment target ID</p></div></div></td><td><div><div><p><code>--target 1598794 643404</code></p></div></div></td></tr></tbody></table>

## api-mgr:api:deprecate

\> api-mgr:api:deprecate \[flags\] <apiInstanceId>

Deprecates the API instance passed in `<apiInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:api:describe

\> api-mgr:api:describe \[flags\] <apiInstanceId>

Shows details of the API instance passed in `<apiInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:api:download-proxy

\> api-mgr:api:download-proxy \[flags\] <apiInstanceId> <targetPath>

This command downloads the API proxy ZIP file of the API instance passed in `<apiInstanceId>` to a
local directory specified in `<targetPath>`. You cannot download the API proxy of an Omni Gateway
API instance.

This command accepts the `--gatewayVersion` flag to specify the gateway version to download. For
example: `api-mgr:api:download-proxy --gatewayVersion: 4.0.1 643404 /tmp/` This command also accepts
the `--output` flag to specify the response format  
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:api:edit

\> api-mgr:api:edit \[flag\] <apiInstanceId>

Edits the API instance passed in `<apiInstanceId>`. Editing a deployed Omni Gateway API instance
redeploys the instance.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-f, --isFlex</code></p></div></div></td><td><div><div><p>Indicates whether this is an Omni Gateway API instance.<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--isFlex</code></p></div></div></td></tr><tr><td><div><div><p><code>-m, --muleVersion4OrAbove</code></p></div></div></td><td><div><div><p>Indicates whether this is a Mule 4 API instance.<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--muleVersionOrAbove</code></p></div></div></td></tr><tr><td><div><div><p><code>-p, --withProxy</code></p></div></div></td><td><div><div><p>Indicates whether the endpoint should use a proxy.<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--withProxy</code></p></div></div></td></tr><tr><td><div><div><p><code>-r, --referencesUserDomain</code></p></div></div></td><td><div><div><p>Indicates whether a proxy should reference a user domain.<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--referencesUserDomain</code></p></div></div></td></tr><tr><td><div><div><p><code>--apiInstanceLabel</code></p></div></div></td><td><div><div><p>API instance label</p></div></div></td><td><div><div><p><code>--apiInstanceLabel exampleLabel</code></p></div></div></td></tr><tr><td><div><div><p><code>--deploymentType</code></p></div></div></td><td><div><div><p>Deployment type<br>Options: <code>cloudhub</code>, <code>hybrid</code>, <code>rtf</code> (required)</p></div></div></td><td><div><div><p><code>--deploymentType cloudhub</code></p></div></div></td></tr><tr><td><div><div><p><code>--endpointUri</code></p></div></div></td><td><div><div><p>Consumer endpoint URI (required)</p></div></div></td><td><div><div><p><code>--endpointUri /udp://localhost:65432</code></p></div></div></td></tr><tr><td><div><div><p><code>--inboundSecretGroupId</code></p></div></div></td><td><div><div><p>Inbound secret group ID</p></div></div></td><td><div><div><p><code>--inboundSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--inboundTlsContextId</code></p></div></div></td><td><div><div><p>Outbound TLS context ID<br>Supply the <code>--inboundSecretGroupId</code> of the TLS context’s secret group. To remove a TLS context, apply the flag with the following value: <code>--inboundTlsContextId "null"</code>.</p></div></div></td><td><div><div><p><code>--inboundTlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--outboundSecretGroupId</code></p></div></div></td><td><div><div><p>Outbound secret group ID.</p></div></div></td><td><div><div><p><code>--outboundSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--outboundTlsContextId</code></p></div></div></td><td><div><div><p>Outbound TLS context ID.<br>Supply the <code>--outboundSecretGroupId</code> of the TLS context’s secret group. To remove a TLS context, apply the flag with the following value: <code>--outboundTlsContextId "null"</code>.</p></div></div></td><td><div><div><p><code>--outboundTlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--path</code></p></div></div></td><td><div><div><p>Proxy path (required)</p></div></div></td><td><div><div><p><code>--path /http://localhost:3000</code></p></div></div></td></tr><tr><td><div><div><p><code>--port</code></p></div></div></td><td><div><div><p>Proxy port (required)</p></div></div></td><td><div><div><p><code>--port 8080</code></p></div></div></td></tr><tr><td><div><div><p><code>--providerId</code></p></div></div></td><td><div><div><p>Client Identity Provider Id that the API is associated with<br>Default is Anypoint Platform Client Provider</p></div></div></td><td><div><div><p><code>--providerId 1787c36ab544466698e380131040faad</code></p></div></div></td></tr><tr><td><div><div><p><code>--responseTimeout</code></p></div></div></td><td><div><div><p>Maximum response timeout(required)</p></div></div></td><td><div><div><p><code>--responseTimeout 10</code></p></div></div></td></tr><tr><td><div><div><p><code>--routing</code></p></div></div></td><td><div><div><p>API instance routes as a JSON array. Each route defines a label, routing rules, and upstream references with weights.</p></div></div></td><td><div><div><p><code>--routing '[{"label":"Rule 1","rules":{"path":"/path"},"upstreams":[{"id":"upstream-id","weight":100}]}]'</code></p></div></div></td></tr><tr><td><div><div><p><code>--scheme</code></p></div></div></td><td><div><div><p>Proxy scheme (required)<br>Supported values: <code>http</code>, <code>https</code>.</p></div></div></td><td><div><div><p><code>--scheme http</code></p></div></div></td></tr><tr><td><div><div><p><code>--serviceName</code></p></div></div></td><td><div><div><p>WSDL service name<br>Omni Gateway does not support this flag</p></div></div></td><td><div><div><p><code>--serviceName ExampleServerName</code></p></div></div></td></tr><tr><td><div><div><p><code>--serviceNamespace</code></p></div></div></td><td><div><div><p>WSDL service namespace. Omni Gateway does not support this flag.</p></div></div></td><td><div><div><p><code>--serviceNamespace exampleServiceName</code></p></div></div></td></tr><tr><td><div><div><p><code>--servicePort</code></p></div></div></td><td><div><div><p>WSDL service port<br>Omni Gateway does not support this flag</p></div></div></td><td><div><div><p><code>--servicePort 443</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Endpoint type<br>Supported options: <code>http</code>, <code>raml</code>, <code>wsdl</code>, <code>mcp</code>, <code>a2a</code>, <code>llm</code>, <code>grpc</code></p></div></div></td><td><div><div><p><code>--type http</code></p></div></div></td></tr><tr><td><div><div><p><code>--updateApisInSamePort</code></p></div></div></td><td><div><div><p>Updates the TLS context of API instances sharing the port of this API.</p></div></div></td><td><div><div><p><code>--updateApisInSamePort</code></p></div></div></td></tr><tr><td><div><div><p><code>--uri</code></p></div></div></td><td><div><div><p>Implementation URI.</p></div></div></td><td><div><div><p><code>--uri /udp://localhost:65432</code></p></div></div></td></tr></tbody></table>

## api-mgr:api:list

\> api-mgr:api:list \[flags\]

Lists all APIs in API Manager 2.x.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--apiVersion</code></p></div></div></td><td><div><div><p>API version that filters results</p></div></div></td><td><div><div><p><code>--apiVersion 1.0.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--assetId</code></p></div></div></td><td><div><div><p>Asset ID that filters results</p></div></div></td><td><div><div><p><code>--assetId ([group_id]/)&lt;asset_id&gt;/&lt;version&gt;</code></p></div></div></td></tr><tr><td><div><div><p><code>--instanceLabel</code></p></div></div></td><td><div><div><p>API instance label that filters results</p></div></div></td><td><div><div><p><code>--instanceLabel exampleLabel</code></p></div></div></td></tr><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Number of results to retrieve</p></div></div></td><td><div><div><p><code>--limit 50</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the amount of APIs passed</p></div></div></td><td><div><div><p><code>--offset 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--sort</code></p></div></div></td><td><div><div><p>Sorts the results in the field name passed<br>Supported values are: <code>id</code>, <code>name</code>, <code>createdDate</code>, and <code>updatedDate</code></p></div></div></td><td><div><div><p><code>--sort updatedDate</code></p></div></div></td></tr></tbody></table>

## api-mgr:api:manage

\> api-mgr:api:manage \[flags\] <assetId> <assetVersion>

Manages a new API, API version, or new API instance with the Exchange asset passed in `<assetId>`,
and the version passed in `<assetVersion>`.

> [!NOTE] Omni Gateway API instances created with Anypoint CLI do not support multiple upstream
> services. To create Omni Gateway API instances with multiple upstream services, see:
>
> - [Add an API in Connected Mode](https://docs.mulesoft.com/api-manager/latest/create-instance-task-flex)
>
> - [Add an API in Local Mode](https://docs.mulesoft.com/gateway/latest/local-publish-api-multiple-services).

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-f, --isFlex</code></p></div></div></td><td><div><div><p>Indicates whether this is an Omni Gateway API instance.<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--isFlex</code></p></div></div></td></tr><tr><td><div><div><p><code>-m, --muleVersion4OrAbove</code></p></div></div></td><td><div><div><p>Indicates whether this is a Mule 4 API instance.<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--muleVersionOrAbove</code></p></div></div></td></tr><tr><td><div><div><p><code>-p, --withProxy</code></p></div></div></td><td><div><div><p>Indicates whether the endpoint should use a proxy.<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--withProxy</code></p></div></div></td></tr><tr><td><div><div><p><code>-r, --referencesUserDomain</code></p></div></div></td><td><div><div><p>Indicates whether a proxy should reference a user domain.<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--referencesUserDomain</code></p></div></div></td></tr><tr><td><div><div><p>`--apiInstanceLabel `</p></div></div></td><td><div><div><p>API instance label</p></div></div></td><td><div><div><p><code>--apiInstanceLabel exampleLabel</code></p></div></div></td></tr><tr><td><div><div><p><code>--deploymentType</code></p></div></div></td><td><div><div><p>Deployment type<br>Options: <code>cloudhub2</code>, <code>cloudhub</code>, <code>hybrid</code>, <code>rtf</code> (required)</p></div></div></td><td><div><div><p><code>--deploymentType hybrid</code></p></div></div></td></tr><tr><td><div><div><p><code>--endpointUri</code></p></div></div></td><td><div><div><p>Consumer endpoint URI (required)</p></div></div></td><td><div><div><p><code>--endpointUri /udp://localhost:65432</code></p></div></div></td></tr><tr><td><div><div><p><code>--inboundSecretGroupId</code></p></div></div></td><td><div><div><p>Inbound secret group ID</p></div></div></td><td><div><div><p><code>--inboundSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--inboundTlsContextId</code></p></div></div></td><td><div><div><p>Outbound TLS Context ID<br>Supply the <code>--inboundSecretGroupId</code> of the TLS Context’s secret group. To remove a TLS Context, apply the flag with the following value: <code>--inboundTlsContextId "null"</code>.</p></div></div></td><td><div><div><p><code>--inboundTlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--outboundSecretGroupId</code></p></div></div></td><td><div><div><p>Outbound secret group ID.</p></div></div></td><td><div><div><p><code>--outboundSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--outboundTlsContextId</code></p></div></div></td><td><div><div><p>Outbound TLS context ID.<br>Supply the <code>--outboundSecretGroupId</code> of the TLS context’s secret group. To remove a TLS context, apply the flag with the following value: <code>--outboundTlsContextId "null"</code>.</p></div></div></td><td><div><div><p><code>--outboundTlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--path</code></p></div></div></td><td><div><div><p>Proxy path (required)</p></div></div></td><td><div><div><p><code>--path /http://localhost:3000</code></p></div></div></td></tr><tr><td><div><div><p><code>--port</code></p></div></div></td><td><div><div><p>Proxy port (required)</p></div></div></td><td><div><div><p><code>--port 8080</code></p></div></div></td></tr><tr><td><div><div><p><code>--providerId</code></p></div></div></td><td><div><div><p>Client Identity Provider Id that the API is associated with<br>Default is Anypoint Platform Client Provider</p></div></div></td><td><div><div><p><code>--providerId 1787c36ab544466698e380131040faad</code></p></div></div></td></tr><tr><td><div><div><p><code>--responseTimeout</code></p></div></div></td><td><div><div><p>Maximum response timeout(required)</p></div></div></td><td><div><div><p><code>--responseTimeout 10</code></p></div></div></td></tr><tr><td><div><div><p><code>--scheme</code></p></div></div></td><td><div><div><p>Proxy scheme (required)<br>Supported values: <code>http</code>, <code>https</code>.</p></div></div></td><td><div><div><p><code>--scheme http</code></p></div></div></td></tr><tr><td><div><div><p><code>--serviceName</code></p></div></div></td><td><div><div><p>WSDL service name<br>Omni Gateway does not support this flag</p></div></div></td><td><div><div><p><code>--serviceName ExampleServerName</code></p></div></div></td></tr><tr><td><div><div><p><code>--serviceNamespace</code></p></div></div></td><td><div><div><p>WSDL service namespace. Omni Gateway does not support this flag.</p></div></div></td><td><div><div><p><code>--serviceNamespace exampleServiceName</code></p></div></div></td></tr><tr><td><div><div><p><code>--servicePort</code></p></div></div></td><td><div><div><p>WSDL service port<br>Omni Gateway does not support this flag</p></div></div></td><td><div><div><p><code>--servicePort 443</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Endpoint type<br>Supported options: <code>http</code>, <code>raml</code>, <code>wsdl</code>, <code>mcp</code>, <code>a2a</code>, <code>llm</code>, <code>grpc</code></p></div></div></td><td><div><div><p><code>--type http</code></p></div></div></td></tr><tr><td><div><div><p><code>--uri</code></p></div></div></td><td><div><div><p>Implementation URI</p></div></div></td><td><div><div><p><code>--uri /udp://localhost:65432</code></p></div></div></td></tr></tbody></table>

## api-mgr:api:promote

\> api-mgr:api:promote \[flags\] <apiInstanceId> <sourceEnvId>

Promotes the API instance passed in `<apiInstanceId>` from the source environment in
`<sourceEnvId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-a, --copyAlerts</code></p></div></div></td><td><div><div><p>Indicates whether to copy alerts<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--copyAlerts</code></p></div></div></td></tr><tr><td><div><div><p><code>-p, --copyPolicies</code></p></div></div></td><td><div><div><p>Indicates whether to copy policies<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--copyPolicies</code></p></div></div></td></tr><tr><td><div><div><p><code>-t, --copyTiers</code></p></div></div></td><td><div><div><p>Indicates whether to copy tiers<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--copyTiers</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--providerId</code></p></div></div></td><td><div><div><p>Indicates the provider’s ID associated with the API.</p></div></div></td><td><div><div><p><code>--providerId 1787c36ab544466698e380131040faad</code></p></div></div></td></tr></tbody></table>

## api-mgr:api:redeploy

\> api-mgr:api:redeploy \[flags\] <apiInstanceId>

Redeploys the API instance passed in `<apiInstanceId>` to the deployment target set up in the flags
described below.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--applicationName</code></p></div></div></td><td><div><div><p>Application name</p></div></div></td><td><div><div><p><code>--applicationName Muleapp 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--environmentName</code></p></div></div></td><td><div><div><p>Target environment name<br>Include to redeploy APIs from unclassified environments</p></div></div></td><td><div><div><p><code>--environmentName mulesoftEnvironment 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--gatewayVersion</code></p></div></div></td><td><div><div><p>CloudHub Gateway version</p></div></div></td><td><div><div><p><code>--gatewayVersion 9.9.9 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--javaVersion</code></p></div></div></td><td><div><div><p>Gateway Java version<br>This flag only works if the target flag was set as <code>RTF</code>, <code>CH</code>, or <code>CH2</code></p></div></div></td><td><div><div><p><code>--javaVersion 17 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--overwrite</code></p></div></div></td><td><div><div><p>Update application if it exists<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--overwrite</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--releaseChannel</code></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><br>This flag only works if the target flag was set as <code>RTF</code>, <code>CH</code>, or <code>CH2</code></p></div></div></td><td><div><div><p><code>--releaseChannel EDGE 643404</code></p></div></div></td></tr><tr><td><div><div><p><code>--target</code></p></div></div></td><td><div><div><p>Hybrid, RTF, CH, or CH2 deployment target ID</p></div></div></td><td><div><div><p><code>--target 1598794 643404</code></p></div></div></td></tr></tbody></table>

## api-mgr:api:undeprecate

\> api-mgr:api:undeprecate \[flags\] <apiInstanceId>

Undeprecates the API instance passed in `<apiInstanceId>`.

This commands accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:application:add-owner

\> api-mgr:application:add-owner \[flags\] <applicationId> <id> <entityType>

Adds the owner passed in `<id>` with the entity type passed in `<entityType>` to the client
application passed in `<applicationId>`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:application:import

\> api-mgr:application:import \[flags\] <providerId> <clientId>

Imports the client application passed in `<clientId>` from the external client identity provider
passed in `<providerId>`. The client identity provider must have the import feature enabled.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--description</code></p></div></div></td><td><div><div><p>Description of the client application to import.</p></div></div></td><td><div><div><p><code>--description "Example application description"</code></p></div></div></td></tr><tr><td><div><div><p><code>--url</code></p></div></div></td><td><div><div><p>URL of the client application to import.</p></div></div></td><td><div><div><p><code>--url <a href="https://example.com">https://example.com</a></code></p></div></div></td></tr></tbody></table>

## api-mgr:application:possible-owners-list

\> api-mgr:application:possible-owners-list \[flags\]

Lists the possible owners for a client application in the current organization.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--search</code></p></div></div></td><td><div><div><p>Search string to filter results.</p></div></div></td><td><div><div><p><code>--search example</code></p></div></div></td></tr><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Number of results to retrieve.</p></div></div></td><td><div><div><p><code>--limit 10</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Number of results to skip.</p></div></div></td><td><div><div><p><code>--offset 10</code></p></div></div></td></tr></tbody></table>

## api-mgr:client-provider:list-importable

\> api-mgr:client-provider:list-importable \[flags\]

Lists the client identity providers that have the import feature enabled in the current
organization.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:contract:delete

\> api-mgr:contract:delete \[flags\] <apiInstanceId> <clientId>

This command deletes the contract between the API instance passed in `<apiInstanceId>`, and the
client passed in `<clientId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:contract:list

\> api-mgr:contract:list \[flags\] <apiInstanceId> \[searchText\]

Lists all contracts of the API passed in `<apiInstanceId>`.

> [!TIP] You can specify keywords in searchText to limit results of APIs containing those specific
> keywords.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Number of results to retrieve</p></div></div></td><td><div><div><p><code>--limit 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the amount of APIs passed</p></div></div></td><td><div><div><p><code>--offset 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--sort</code></p></div></div></td><td><div><div><p>Sorts the contracts by the criteria associated with their client applications<br>Supported values are: <code>id</code>, <code>name</code>, <code>createdDate</code>, and <code>updatedDate</code></p></div></div></td><td><div><div><p><code>--sort id</code></p></div></div></td></tr></tbody></table>

## api-mgr:policy:apply

\> api-mgr:policy:apply \[flags\] <apiInstanceId> <policyId>

Applies the policy passed in `<policyId>` to the API instance passed in `<apiInstanceId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-c, --config</code></p></div></div></td><td><div><div><p>Pass the configuration data as a JSON string</p></div></div></td><td><div><div><p><code>--config '{\"username\":\"user\",\"password\":\"teste\"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--configFile</code></p></div></div></td><td><div><div><p>Pass the configuration data as a file</p></div></div></td><td><div><div><p><code>--configFile ./config.json</code></p></div></div></td></tr><tr><td><div><div><p><code>--groupId</code></p></div></div></td><td><div><div><p>Mule 4 policy group ID<br>This value defaults to the MuleSoft group ID.</p></div></div></td><td><div><div><p><code>--groupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>-p, --pointcut [dataJSON]</code></p></div></div></td><td><div><div><p>Pass pointcut data as JSON strings</p></div></div></td><td><div><div><p><code>--pointcut '[{"methodRegex":"GET|PUT","uriTemplateRegex":"/users*"}]'</code></p></div></div></td></tr><tr><td><div><div><p><code>--policyVersion</code></p></div></div></td><td><div><div><p>Mule 4 policy version.</p></div></div></td><td><div><div><p><code>--policyVersion 1.0.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--upstreamId</code></p></div></div></td><td><div><div><p>Configure upstream</p></div></div></td><td><div><div><p><code>--upstreamId 550e8400-e29b-41d4-a716-446655440000</code></p></div></div></td></tr></tbody></table>

The following example defines a rate limit of one request every ten seconds:

{ "rateLimits": \[{ "maximumRequests": 1, "timePeriodInMilliseconds": 10000 }\], "clusterizable":
true, "exposeHeaders": false }

> [!NOTE] Even if you plan to use the default values, you must configure all required policy
> parameters when applying a policy with Anypoint CLI,

## api-mgr:policy:describe

\> api-mgr:policy:describe \[flags\] <policyId>

Shows the description and available base configuration properties of the policy name passed in
`<policyId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--groupId</code></p></div></div></td><td><div><div><p>Mule 4 policy group ID</p></div><div><p>+ Defaults to the MuleSoft group ID.</p></div></div></td><td><div><div><p><code>--groupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--policyVersion</code></p></div></div></td><td><div><div><p>Mule 4 policy version</p></div></div></td><td><div><div><p><code>--policyVersion 1.0.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format<br>Supported values are <code>table</code> (default) and <code>json</code>.</p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## api-mgr:policy:disable

\> api-mgr:policy:disable \[flags\] <apiInstanceId> <policyInstanceId>

Disables the policy passed in `<policyInstanceId>` from the API instance passed in
`<apiInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:policy:edit

\> api-mgr:policy:edit \[flags\] <apiInstanceId> <policyInstanceId>

Edits the policy configuration passed in `<policyInstanceId>` for the API instance passed in
`<apiInstanceId>`.

> [!NOTE] If you are udpating an included Mule Gateway policy, you can include only the changed
> values in the configuration. However, if you are updating a custom policy, you must send the full
> configuration each time a custom policy is edited.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-c</code>, <code>--config</code></p></div></div></td><td><div><div><p>Pass the configuration data as a JSON string</p></div></div></td><td><div><div><p><code>--config '{\"username\":\"user\",\"password\":\"teste\"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--configFile</code></p></div></div></td><td><div><div><p>Pass the configuration data as a file</p></div></div></td><td><div><div><p><code>--configFile ./config.json</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>-p, --pointcut</code></p></div></div></td><td><div><div><p>Pass pointcut data as JSON strings</p></div></div></td><td><div><div><p><code>-p '[{"methodRegex":"GET|PUT","uriTemplateRegex":"/users*"}]'</code></p></div></div></td></tr></tbody></table>

## api-mgr:policy:enable

\> api-mgr:policy:enable \[flags\] <apiInstanceId> <policyInstanceId>

Enables the policy passed in `<policyInstanceId>` for the API instance passed in `<apiInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:policy:list

\> api-mgr:policy:list \[flags\] \[apiInstanceId\]

Lists all policies for all APIs in API Manager 2.x.  
Specify the `--apiInstanceId` flag to list the policies applied to that API instance. Without the
`--apiInstanceId` flag, the command lists all policies for all APIs.

This command accepts the `-m, --muleVersion4OrAbove` flag.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:policy:remove

\> api-mgr:policy:remove \[flags\] <apiInstanceId> <policyInstanceId>

This command removes the policy specified in `<policyInstanceId>` from the API instance passed in
`<apiInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:tier:add

\> api-mgr:tier:add \[flags\] <apiInstanceId>

This command creates an SLA tier for the API instance passed in `<apiInstanceId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>-a, --autoApprove</code></p></div></div></td><td><div><div><p>Indicates whether the SAL tier should be auto-approved<br>Include the flag to enable it</p></div></div></td><td><div><div><p><code>--autoApprove</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Tier name</p></div></div></td><td><div><div><p><code>--name muleSLAtier</code></p></div></div></td></tr><tr><td><div><div><p><code>--description</code></p></div></div></td><td><div><div><p>Tier description</p></div></div></td><td><div><div><p><code>--description tier example description</code></p></div></div></td></tr><tr><td><div><div><p><code>-l, --limit</code></p></div></div></td><td><div><div><p>Single instance of an SLA tier limit in the form <code>--limit A,B,C</code> where:</p></div><div><ul><li><p><code>A</code> is a boolean indicating whether this limit is visible to the user.</p></li><li><p><code>B</code> is a number of requests per "C" time period.</p></li><li><p><code>C</code> is the time period unit. Time period options are:</p><div><ul><li><p><code>ms</code>(millisecond)</p></li><li><p><code>sec</code>(second)</p></li><li><p><code>min</code>(minute)</p></li><li><p><code>hr</code>(hour)</p></li><li><p><code>d</code>(day)</p></li><li><p><code>wk</code>(week)</p></li><li><p><code>mo</code>(month)</p></li><li><p><code>yr</code>(year)</p></li></ul></div></li></ul></div></div></td><td><div><div><p><code>--limit true,100,min</code><br></p></div><div><div data-type="TIP">To create multiple limits, you can provide multiple <code>--limit</code> options.<br>For example: <code>-l true,100,sec -l false,20,min</code>.</div></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## api-mgr:tier:copy

\> api-mgr:tier:copy \[flags\] <sourceAPIInstanceId> <targetAPIInstanceId>

Copies the SLA tier from the API instance passed in `<sourceAPIInstanceId>` to the API instance Id
passed in `<targetAPIInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:tier:delete

\> api-mgr:tier:delete \[flags\] <apiInstanceId> <tierId>

This command deletes the SLA tier passed in `<tierId>` from API instance passed in
`<apiInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:tier:list

\> api-mgr:tier:list \[flags\] <apiInstanceId> \[searchText\]

This command lists the SLA tiers of the API instance passed in `<apiInstanceId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Number of results to retrieve</p></div></div></td><td><div><div><p><code>--limit 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the amount of APIs passed</p></div></div></td><td><div><div><p><code>--offset 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--sort</code></p></div></div></td><td><div><div><p>Sorts the results in the field name passed<br>Supported values are: <code>id</code>, <code>name</code>, <code>createdDate</code>, and <code>updatedDate</code></p></div></div></td><td><div><div><p><code>--sort id</code></p></div></div></td></tr></tbody></table>

## api-mgr:upstream:add

\> api-mgr:upstream:add \[flags\] <apiInstanceId> <uri>

Creates an upstream for the API instance passed in `<apiInstanceId>` with the URI passed in `<uri>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--label</code></p></div></div></td><td><div><div><p>Label for the upstream</p></div></div></td><td><div><div><p><code>--label my-upstream</code></p></div></div></td></tr><tr><td><div><div><p><code>--tlsContextId</code></p></div></div></td><td><div><div><p>TLS context ID to set on the upstream</p></div></div></td><td><div><div><p><code>--tlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--tlsContextSecretGroupId</code></p></div></div></td><td><div><div><p>Secret group ID for the TLS context specified in <code>--tlsContextId</code></p></div></div></td><td><div><div><p><code>--tlsContextSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Format for the response, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## api-mgr:upstream:bulk-edit

\> api-mgr:upstream:bulk-edit \[flags\] <apiInstanceId>

Bulk edits the TLS context for all upstreams of the API instance passed in `<apiInstanceId>` using a
single API update.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts these flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--tlsContextId</code> <strong>(required)</strong></p></div></div></td><td><div><div><p>TLS context ID to set on all upstreams. Pass <code>null</code> to remove the TLS context from all upstreams.</p></div></div></td><td><div><div><p><code>--tlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--tlsContextSecretGroupId</code></p></div></div></td><td><div><div><p>Secret group ID for the TLS context specified in <code>--tlsContextId</code></p></div></div></td><td><div><div><p><code>--tlsContextSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Format for the response, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## api-mgr:upstream:delete

\> api-mgr:upstream:delete \[flags\] <apiInstanceId> <upstreamId>

Deletes the upstream passed in `<upstreamId>` from the API instance passed in `<apiInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## api-mgr:upstream:edit

\> api-mgr:upstream:edit \[flags\] <apiInstanceId> <upstreamId>

Edits the upstream passed in `<upstreamId>` for the API instance passed in `<apiInstanceId>`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--uri</code></p></div></div></td><td><div><div><p>Upstream URI</p></div></div></td><td><div><div><p><code>--uri <a href="https://backend.example.com">https://backend.example.com</a></code></p></div></div></td></tr><tr><td><div><div><p><code>--label</code></p></div></div></td><td><div><div><p>Label for the upstream</p></div></div></td><td><div><div><p><code>--label my-upstream</code></p></div></div></td></tr><tr><td><div><div><p><code>--tlsContextId</code></p></div></div></td><td><div><div><p>TLS context ID to set on the upstream. Pass <code>null</code> to remove the TLS context.</p></div></div></td><td><div><div><p><code>--tlsContextId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--tlsContextSecretGroupId</code></p></div></div></td><td><div><div><p>Secret group ID for the TLS context specified in <code>--tlsContextId</code></p></div></div></td><td><div><div><p><code>--tlsContextSecretGroupId 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Format for the response, supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## api-mgr:upstream:list

\> api-mgr:upstream:list \[flags\] <apiInstanceId>

Lists all upstreams for the API instance passed in `<apiInstanceId>`.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=69cb4ee7a6e25af37add1f4b2bb4faef40fa80126df11a5cc1984efcb06145cc url=/mulesoft/current/en-us/anypoint-cli/3.x/cloudhub.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for CloudHub

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

Anypoint CLI supports managing these CloudHub features:

- [CloudHub Applications](https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-apps)

- [CloudHub Dedicated Load Balancers](https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb)

- [Anypoint Virtual Private Cloud](https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-vpc)

<!-- document id=29d71a4ead18a38ec9ad5f379e1fb6f51f4cecccb782c3d70d311ee77459f77a url=/mulesoft/current/en-us/anypoint-cli/latest/cloudhub.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for CloudHub

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

Anypoint CLI supports managing these CloudHub features:

- [CloudHub Applications](https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps)

- [CloudHub Dedicated Load Balancers](https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb)

- [Anypoint Virtual Private Cloud](https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc)

<!-- document id=09cf2aa56220fd9399ea092364019a809601eeb83f06dd06563963a4b525ac37 url=/mulesoft/current/en-us/anypoint-cli/3.x/cloudhub2-apps.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Cloudhub 2.0

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

Use these commands for for deploying and managing applications in applications in Cloudhub 2.0.

<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-application-delete">runtime-mgr application delete</a></p></div></div></td><td><div><div><p>Deletes an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-deploy">runtime-mgr application deploy</a></p></div></div></td><td><div><div><p>Deploys an application to a specified target using an Exchange application and runs the specified runtime version</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-describe">runtime-mgr application describe</a></p></div></div></td><td><div><div><p>Describes an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-describe-json">runtime-mgr application describe-json</a></p></div></div></td><td><div><div><p>Describes an application in a raw JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-download-logs">runtime-mgr application download-logs</a></p></div></div></td><td><div><div><p>Downloads logs of an application from a specification to a specified directory</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-list">runtime-mgr application list</a></p></div></div></td><td><div><div><p>Lists all applications in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-modify">runtime-mgr application modify</a></p></div></div></td><td><div><div><p>Modifies a deployed application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-start">runtime-mgr application start</a></p></div></div></td><td><div><div><p>Starts a stopped application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-stop">runtime-mgr application stop</a></p></div></div></td><td><div><div><p>Stops running an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-tail-logs">runtime-mgr application tail-logs</a></p></div></div></td><td><div><div><p>Tails an application’s logs from a specification</p></div></div></td></tr></tbody></table>

## runtime-mgr application delete

\> runtime-mgr application delete \[options\] <appID>

Deletes the running application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

> [!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 application deploy

\> runtime-mgr application deploy \[options\] <appID> <deploymentTargetID> <runtimeVersion>
<artifactID>

Deploys the application specified in `<appID>` to the deployment target specified using the
following options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>ArtifactId</code></p></div></div></td><td><div><div><p>Artifact ID of the application retrieved from Exchange.</p></div></div></td><td><div><div><p><code>mule-test-plugin</code></p></div></div></td></tr><tr><td><div><div><p><code>deploymentTargetID</code></p></div></div></td><td><div><div><p>ID of the deployment target.<br>You can get this ID directly from Runtime Manager.</p></div></div></td><td><div><div><p><code>app.runetime</code></p></div></div></td></tr><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Name of the application to deploy.</p></div></div></td><td><div><div><p><code>testCloudhub2app</code></p></div></div></td></tr><tr><td><div><div><p><code>runtimeVersion</code></p></div></div></td><td><div><div><p>Runtime version of the deployment target.</p></div></div></td><td><div><div><p><code>1.0.1</code></p></div></div></td></tr></tbody></table>

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes
these options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>assetVersion</code></p></div></div></td><td><div><div><p>Version of the Exchange application to use.<br>Default: latest application version</p></div></div></td><td><div><div><p><code>2.0.4</code></p></div></div></td></tr><tr><td><div><div><p><code>clustered</code></p></div></div></td><td><div><div><p>Enables clustered nodes, which requires at least two replicas.<br>Default:.<code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><div><div><p><code>disableAmLogForwarding</code></p></div></div></td><td><div><div><p>Disables forwarding applications logs to Anypoint Monitoring.<br>Default: <code>enabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>forwardSslSession</code></p></div></div></td><td><div><div><p>Enables SSL session forwarding.<br>Default: <code>disabled</code><br>Values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><div><div><p><code>groupID</code></p></div></div></td><td><div><div><p>Group ID of the asset to deploy.<br>Default: selected organization ID</p></div></div></td><td><div><div><p><code>org.mule.test</code></p></div></div></td></tr><tr><td><div><div><p><code>lastMileSecurity</code></p></div></div></td><td><div><div><p>Enables Last Mile Security.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>objectStoreV2</code></p></div></div></td><td><div><div><p>Enables Object Store v2.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>pathRewrite</code></p></div></div></td><td><div><div><p>Supplies the base path expected by the HTTP listener in your application.<br>Format: must begin with <code>/</code></p></div></div></td><td><div><div><p><code>/http://localhost:3000</code></p></div></div></td></tr><tr><td><div><div><p><code>property</code></p></div></div></td><td><div><div><p>Sets a property.<br>Format: <code>name:value</code>. Can be specified multiple times.<br>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters.</p></div></div></td><td><div><div><p><code>--property "gcp.privateKey:dGVzdA\=\="</code></p></div></div></td></tr><tr><td><div><div><p><code>propertiesFile</code></p></div></div></td><td><div><div><p>Replaces all properties with values from a selected file.<br>Format: one or more lines in <code>name: value</code> style</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/properties.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>publicEndpoints</code></p></div></div></td><td><div><div><p>Supplies endpoints to reach via the public internet.<br>Format: separated by commas, no spaces</p></div></div></td><td><div><div><p><code>my-superapp-example:/status?limit=10</code></p></div></div></td></tr><tr><td><div><div><p><code>replicas</code></p></div></div></td><td><div><div><p>Number of replicas. Must be above <code>0</code>.<br>Default: <code>1</code></p></div></div></td><td><div><div><p><code>2</code></p></div></div></td></tr><tr><td><div><div><p><code>replicaSize</code></p></div></div></td><td><div><div><p>Size of replicas in Vcores.<br>Default: <code>0.1</code></p></div></div></td><td><div><div><p><code>0.5</code></p></div></div></td></tr><tr><td><div><div><p><code>scopeLoggingConfig</code></p></div></div></td><td><div><div><p>Defines scope logging.<br>Format: <code>scopeName: logLevel</code>, separated by commas, no spaces</p></div></div></td><td><div><div><p><code>testscope1:WARN,testscope2:DEBUG</code></p></div></div></td></tr><tr><td><div><div><p><code>scopeLoggingConfigFile</code></p></div></div></td><td><div><div><p>Uploads a file to define scope logging.<br>Format: one tupple per line, style: <code>{scope: scopeName, logLevel: logLevelType}</code> enclosed with <code>{}</code> <code>()</code> or <code>[]</code></p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>secureProperty</code></p></div></div></td><td><div><div><p>Sets a secure property.<br>Format: <code>name:value</code>. Can be specified multiple times.<br>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters.</p></div></div></td><td><div><div><p><code>--secureProperty "gcp.privateKey:dGVzdA\=\="</code></p></div></div></td></tr><tr><td><div><div><p><code>updateStrategy</code></p></div></div></td><td><div><div><p>Updates the strategy used.<br>Default: <code>rolling</code></p></div></div></td><td><div><div><p><code>recreate</code></p></div></div></td></tr></tbody></table>

## runtime-mgr application describe

\> runtime-mgr application describe \[options\] <appID>

Displays information about the application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

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

## runtime-mgr application describe-json

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

Displays a raw JSON response from the application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

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

## runtime-mgr application download-logs

\> runtime-mgr application download-logs \[options\] <appID> <directory> <specID>

Downloads logs for the application specified in `<appID>` from the specification specified in
`<specID>` to the selected directory.

To get the `<appID>`, run the `runtime-mgr application list` command.

To get the `<specID>` run the `runtime-mgr application describe` command.

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

## runtime-mgr application list

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

Lists all applications in your organization.

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

## runtime-mgr application modify

\> runtime-mgr application modify \[options\] <appID> <certificateName>

Updates the settings of an existing application specified in `<appID>`. To get the `<appID>`, run
the `runtime-mgr application list` command.

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes
these options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>ArtifactId</code></p></div></div></td><td><div><div><p>ID of the application retrieved from Exchange.</p></div></div></td><td><div><div><p><code>mule-maven-plugin</code></p></div></div></td></tr><tr><td><div><div><p><code>assetVersion</code></p></div></div></td><td><div><div><p>Version of the Exchange application to use.<br>Default: latest application version</p></div></div></td><td><div><div><p><code>2.0.4</code></p></div></div></td></tr><tr><td><div><div><p><code>clustered</code></p></div></div></td><td><div><div><p>Enables clustered nodes, which requires at least two replicas.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><div><div><p><code>disableAmLogForwarding</code></p></div></div></td><td><div><div><p>Disables forwarding applications logs to Anypoint Monitoring.<br>Default: <code>enabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>forwardSslSession</code></p></div></div></td><td><div><div><p>Enables SSL session forwarding.<br>Default: <code>disabled</code><br>Values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><div><div><p><code>groupID</code></p></div></div></td><td><div><div><p>Group ID of the asset to deploy.<br>Default: selected organization ID.</p></div></div></td><td><div><div><p><code>org.mule.testgroup</code></p></div></div></td></tr><tr><td><div><div><p><code>lastMileSecurity</code></p></div></div></td><td><div><div><p>Enables Last Mile Security.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>objectStoreV2</code></p></div></div></td><td><div><div><p>Enables object store v2.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>pathRewrite</code></p></div></div></td><td><div><div><p>Supplies the base path expected by the HTTP listener in your application.<br>Format: must begin with <code>/</code></p></div></div></td><td><div><div><p><code>/http://localhost:3000</code>.</p></div></div></td></tr><tr><td><div><div><p><code>property</code></p></div></div></td><td><div><div><p>Sets a property.<br>Format: <code>name:value</code>. Can be specified multiple times.<br>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters.</p></div></div></td><td><div><div><p><code>--property "gcp.privateKey:dGVzdA\=\="</code></p></div></div></td></tr><tr><td><div><div><p><code>propertiesFile</code></p></div></div></td><td><div><div><p>Replaces all properties with values from a selected file.<br>Format: one or more lines in <code>name: value</code> style</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/properties.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>publicEndpoints</code></p></div></div></td><td><div><div><p>Supplies endpoints to reach via the public internet.<br>Format: separated by commas, no spaces</p></div></div></td><td><div><div><p><code>my-superapp-example: /status?limit=10</code></p></div></div></td></tr><tr><td><div><div><p><code>replicas</code></p></div></div></td><td><div><div><p>Number of replicas. Must be above <code>0</code>.<br>Default: <code>1</code></p></div></div></td><td><div><div><p><code>2</code></p></div></div></td></tr><tr><td><div><div><p><code>replicaSize</code></p></div></div></td><td><div><div><p>Size of replicas in Vcores.<br>Default: <code>0.1</code></p></div></div></td><td><div><div><p><code>0.5</code></p></div></div></td></tr><tr><td><div><div><p><code>runtimeVersion</code></p></div></div></td><td><div><div><p>Runtime version of the deployment target.</p></div></div></td><td><div><div><p><code>1.0.1</code></p></div></div></td></tr><tr><td><div><div><p><code>scopeLoggingConfig</code></p></div></div></td><td><div><div><p>Defines scope logging.<br>Format: <code>scopeName: logLevel</code>, separated by commas, no spaces</p></div></div></td><td><div><div><p><code>testscope1:WARN,testscope2:DEBUG</code></p></div></div></td></tr><tr><td><div><div><p><code>scopeLoggingConfigFile</code></p></div></div></td><td><div><div><p>Uploads a file to define scope logging.<br>Format: 1 tupple per line, style: <code>{scope: scopeName, logLevel: logLevelType}</code> enclosed with <code>{}</code> <code>()</code> or <code>[]</code></p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>secureProperty</code></p></div></div></td><td><div><div><p>Sets a secure property.<br>Format: <code>name:value</code>. Can be specified multiple times.<br>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters.</p></div></div></td><td><div><div><p><code>--secureProperty "gcp.privateKey:dGVzdA\=\="</code></p></div></div></td></tr><tr><td><div><div><p><code>updateStrategy</code></p></div></div></td><td><div><div><p>Updates the strategy used.<br>Default: <code>rolling</code></p></div></div></td><td><div><div><p><code>recreate</code></p></div></div></td></tr></tbody></table>

## runtime-mgr application start

\> runtime-mgr application start \[options\] <appid>

Starts running the application specified in `<appid>`. To get this ID, run the
`runtime-mgr application list` command.

This command accepts only the default option `--help`.

## runtime-mgr application stop

\> runtime-mgr application stop \[options\] <appID>

Stops running the application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

This command accepts only the default option `--help`.

## runtime-mgr application tail-logs

\> runtime-mgr:application:tail-logs \[options\] <appID> <specID>

Tails application logs for the application specificied in `<appID>` from the specification specified
in `<specID>`.

To get the `<appID>`, run the `runtime-mgr application list` command.

To get the `<specID>` run the `runtime-mgr application describe` command.

This command accepts only the default option `--help`.

<!-- document id=9f9df9e632abe1b8352d1f9efd7ff827b1a46a8f8e49bcbe07f9be1aeec43538 url=/mulesoft/current/en-us/anypoint-cli/latest/cloudhub2-apps.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Cloudhub 2.0

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

Use these commands for deploying and managing applications in Cloudhub 2.0. For more information
about how to use these commands, refer to the [CloudHub documentation](https://docs.mulesoft.com/cloudhub/).

<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-application-delete">runtime-mgr:application:delete</a></p></div></div></td><td><div><div><p>Deletes an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-describe">runtime-mgr:application:describe</a></p></div></div></td><td><div><div><p>Describes an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-deploy">runtime-mgr:application:deploy</a></p></div></div></td><td><div><div><p>Deploys an application to a specified target using an Exchange application and runs the specified runtime version</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-download-logs">runtime-mgr:application:download:logs</a></p></div></div></td><td><div><div><p>Downloads logs of an application from a specification to a specified directory</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-list">runtime-mgr:application:list</a></p></div></div></td><td><div><div><p>Lists all applications in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-modify">runtime-mgr:application:modify</a></p></div></div></td><td><div><div><p>Modifies a deployed application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-start">runtime-mgr:application:start</a></p></div></div></td><td><div><div><p>Starts a stopped application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-stop">runtime-mgr:application:stop</a></p></div></div></td><td><div><div><p>Stops running an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-logs">runtime-mgr:application:logs</a></p></div></div></td><td><div><div><p>Tails an application’s logs from a specification</p></div></div></td></tr></tbody></table>

## runtime-mgr:application:delete

\> runtime-mgr:application:delete \[flags\] <appID>

Deletes the running application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

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

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:application:describe

\> runtime-mgr:application:describe \[flags\] <appID>

Displays information about the application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

This command has the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:application:deploy

\> runtime-mgr:application:deploy <appID> <deploymentTargetID> <runtimeVersion> <artifactID>
\[flags\]

Deploys the application specified in `<appID>` to the deployment target specified using the
following options:

> [!NOTE] To deploy applications using a connected app, the connected app must have CloudHub and
> Runtime Manager permission accordingly.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--artifactId</code></p></div></div></td><td><div><div><p>Artifact ID of the application retrieved from Exchange.</p></div></div></td><td><div><div><p><code>--artifactId mule-test-plugin</code></p></div></div></td></tr><tr><td><div><div><p><code>--deploymentTargetId</code></p></div></div></td><td><div><div><p>ID of the deployment target.<br>You can get this ID directly from Runtime Manager.</p></div></div></td><td><div><div><p><code>--deploymentTargetId cloudhub-ap-northeast-1</code></p></div></div></td></tr><tr><td><div><div><p><code>--instanceType</code></p></div></div></td><td><div><div><p>Instance type<br>Only UBP organizations can use this flag. Non-UBP organizations use the <code>--replicaSize</code> flag</p></div></div></td><td><div><div><p><code>--instanceType mule.micro</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name of the application to deploy.</p></div></div></td><td><div><div><p><code>--name testcloudhub2app</code></p></div></div></td></tr><tr><td><div><div><p><code>--replicaSize</code></p></div></div></td><td><div><div><p>Size of replicas in Vcores.<br>Default: <code>0.1</code></p></div></div></td><td><div><div><p><code>--replicaSize 0.5</code></p></div></div></td></tr><tr><td><div><div><p><code>--runtimeVersion</code></p></div></div></td><td><div><div><p>Runtime version of the deployment target.</p></div></div></td><td><div><div><p><code>--runtimeVersion 4.4.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--secureProperty</code></p></div></div></td><td><div><div><p>Sets an encrypted property.</p></div></div></td><td><div><div><p><code>--secureProperty secureTestProperty:true</code></p></div></div></td></tr></tbody></table>

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--assetVersion</code></p></div></div></td><td><div><div><p>Version of the Exchange application to use.</p></div></div></td><td><div><div><p><code>--assetVersion 2.0.4</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]clustered</code></p></div></div></td><td><div><div><p>Enables clustered nodes, which requires at least two replicas.<br>Default:.<code>disabled</code></p></div></div></td><td><div><div><p><code>--no-clustered</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]disableAmLogForwarding</code></p></div></div></td><td><div><div><p>Disables forwarding applications logs to Anypoint Monitoring.<br>Default: <code>enabled</code></p></div></div></td><td><div><div><p><code>--disableAmLogForwarding</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]forwardSslSession</code></p></div></div></td><td><div><div><p>Enables SSL session forwarding.<br>Default: <code>disabled</code></p></div></div></td><td><div><div><p><code>--no-forwardSslSession</code></p></div></div></td></tr><tr><td><div><div><p><code>--groupId</code></p></div></div></td><td><div><div><p>Group ID of the asset to deploy.<br>Default: selected organization ID</p></div></div></td><td><div><div><p><code>--groupId org.mule.test</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]lastMileSecurity</code></p></div></div></td><td><div><div><p>Enables Last Mile Security.<br>Default: <code>disabled</code></p></div></div></td><td><div><div><p><code>--no-lastMileSecurity</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td><td><div><div><p>Enables Object Store v2.<br>Default: <code>disabled</code></p></div></div></td><td><div><div><p><code>--no-objectStoreV2</code></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><td><div><div><p><code>--javaVersion 8</code></p></div></div></td></tr><tr><td><div><div><p><code>--pathRewrite</code></p></div></div></td><td><div><div><p>Supplies the base path expected by the HTTP listener in your application.<br>Format: must begin with <code>/</code></p></div></div></td><td><div><div><p><code>--pathRewrite /api</code></p></div></div></td></tr><tr><td><div><div><p><code>--property</code></p></div></div></td><td><div><div><p>Replaces all existing properties with the specified property.<br>Format: <code>name:value</code></p></div></div></td><td><div><div><p><code>--property testproperty:true</code></p></div></div></td></tr><tr><td><div><div><p><code>--propertiesFile</code></p></div></div></td><td><div><div><p>Replaces all properties with values from a selected file.<br>Format: one or more lines in <code>name: value</code> style</p></div></div></td><td><div><div><p><code>--propertiesFile /Users/mule/Documents/properties.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>--publicEndpoints</code></p></div></div></td><td><div><div><p>Supplies endpoints to reach via the public internet.<br>Format: separated by commas, no spaces</p></div></div></td><td><div><div><p><code>--publicEndpoints <a href="https://my-superapp.anypoint.com/status">https://my-superapp.anypoint.com/status</a></code></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><td><div><div><p><code>--releaseChannel LTS</code></p></div></div></td></tr><tr><td><div><div><p><code>--replicas</code></p></div></div></td><td><div><div><p>Number of replicas. Must be above <code>0</code>.<br>Default: <code>1</code></p></div></div></td><td><div><div><p><code>--replicas 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--replicaSize</code></p></div></div></td><td><div><div><p>Size of replicas in Vcores.<br>Default: <code>0.1</code></p></div></div></td><td><div><div><p><code>--replicaSize 0.5</code></p></div></div></td></tr><tr><td><div><div><p><code>--scopeLoggingConfig</code></p></div></div></td><td><div><div><p>Defines scope logging.<br>Format: <code>scopeName: logLevel</code>, separated by commas, no spaces</p></div></div></td><td><div><div><p><code>--scopeLoggingConfig testscope1:WARN,testscope2:DEBUG</code></p></div></div></td></tr><tr><td><div><div><p><code>--scopeLoggingConfigFile</code></p></div></div></td><td><div><div><p>Uploads a file to define scope logging.<br>Format: one tuple per line, style: <code>{scope: scopeName, logLevel: logLevelType}</code> enclosed with <code>{}</code> <code>()</code> or <code>[]</code></p></div></div></td><td><div><div><p><code>--scopeLoggingConfigFile /Users/mule/Documents/cert.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>--updateStrategy</code></p></div></div></td><td><div><div><p>Updates the strategy used.<br>Default: <code>rolling</code></p></div></div></td><td><div><div><p><code>--updateStrategy recreate</code></p></div></div></td></tr></tbody></table>

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

## runtime-mgr:application:download-logs

\> runtime-mgr:application:download-logs \[flags\] <appID> <directory> <specID>

Downloads logs for the application specified in `<appID>` from the specification specified in
`<specID>` to the selected directory.

To get the `<appID>`, run the `runtime-mgr application list` command.

To get the `<specID>` run the `runtime-mgr application describe` command.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:application:list

\> runtime-mgr:application:list \[flags\]

Lists all applications in your organization.

This command has the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:application:modify

\> runtime-mgr:application:modify <appID> <certificateName> \[flags\]

Updates the settings of an existing application specified in `<appID>`. To get the `<appID>`, run
the `runtime-mgr application list` command.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--artifactId</code></p></div></div></td><td><div><div><p>ID of the application retrieved from Exchange.</p></div></div></td><td><div><div><p><code>--artifactId mule-maven-plugin</code></p></div></div></td></tr><tr><td><div><div><p><code>--assetVersion</code></p></div></div></td><td><div><div><p>Version of the Exchange application to use.</p></div></div></td><td><div><div><p><code>--assetVersion 2.0.4</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]clustered</code></p></div></div></td><td><div><div><p>Enables clustered nodes, which requires at least two replicas.<br>Default: <code>disabled</code></p></div></div></td><td><div><div><p><code>--no-clustered</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]disableAmLogForwarding</code></p></div></div></td><td><div><div><p>Disables forwarding applications logs to Anypoint Monitoring.<br>Default: <code>enabled</code></p></div></div></td><td><div><div><p><code>--disableAmLogForwarding</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]forwardSslSession</code></p></div></div></td><td><div><div><p>Enables SSL session forwarding.<br>Default: <code>disabled</code></p></div></div></td><td><div><div><p><code>--no-forwardSslSession</code></p></div></div></td></tr><tr><td><div><div><p><code>--groupId</code></p></div></div></td><td><div><div><p>Group ID of the asset to deploy.<br>Default: selected organization ID.</p></div></div></td><td><div><div><p><code>--groupId org.mule.testgroup</code></p></div></div></td></tr><tr><td><div><div><p><code>--instanceType</code></p></div></div></td><td><div><div><p>Instance type<br>Only UBP organizations can use this flag. Non-UBP organizations use the <code>--replicaSize</code> flag</p></div></div></td><td><div><div><p><code>--instanceType mule.nano</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]lastMileSecurity</code></p></div></div></td><td><div><div><p>Enables Last Mile Security.<br>Default: <code>disabled</code></p></div></div></td><td><div><div><p><code>--no-lastMileSecurity</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td><td><div><div><p>Enables object store v2.<br>Default: <code>disabled</code></p></div></div></td><td><div><div><p><code>--no-objectStoreV2</code></p></div></div></td></tr><tr><td><div><div><p><code>--pathRewrite</code></p></div></div></td><td><div><div><p>Supplies the base path expected by the HTTP listener in your application.<br>Format: must begin with <code>/</code></p></div></div></td><td><div><div><p><code>--pathRewrite /api</code></p></div></div></td></tr><tr><td><div><div><p><code>--property</code></p></div></div></td><td><div><div><p>Replaces all existing properties with the specified property.<br>Format: <code>name:value</code></p></div></div></td><td><div><div><p><code>--property testproperty:true</code></p></div></div></td></tr><tr><td><div><div><p><code>--propertiesFile</code></p></div></div></td><td><div><div><p>Replaces all properties with values from a selected file.<br>Format: one or more lines in <code>name: value</code> style</p></div></div></td><td><div><div><p><code>--propertiesFile /Users/mule/Documents/properties.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>--publicEndpoints</code></p></div></div></td><td><div><div><p>Supplies endpoints to reach via the public internet.<br>Format: separated by commas, no spaces</p></div></div></td><td><div><div><p><code>--publicEndpoints <a href="https://my-superapp.anypoint.com/status">https://my-superapp.anypoint.com/status</a></code></p></div></div></td></tr><tr><td><div><div><p><code>--replicas</code></p></div></div></td><td><div><div><p>Number of replicas. Must be above <code>0</code>.<br>Default: <code>1</code></p></div></div></td><td><div><div><p><code>--replicas 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--replicaSize</code></p></div></div></td><td><div><div><p>Size of replicas in Vcores.<br>Default: <code>0.1</code></p></div></div></td><td><div><div><p><code>--replicaSize 0.5</code></p></div></div></td></tr><tr><td><div><div><p><code>--runtimeVersion</code></p></div></div></td><td><div><div><p>Runtime version of the deployment target.</p></div></div></td><td><div><div><p><code>--runtimeVersion 4.4.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--secureProperty</code></p></div></div></td><td><div><div><p>Sets an encripted property.</p></div></div></td><td><div><div><p><code>--secureProperty secureTestProperty:true</code></p></div></div></td></tr><tr><td><div><div><p><code>--scopeLoggingConfig</code></p></div></div></td><td><div><div><p>Defines scope logging.<br>Format: <code>scopeName: logLevel</code>, separated by commas, no spaces</p></div></div></td><td><div><div><p><code>--scopeLoggingConfig testscope1:WARN,testscope2:DEBUG</code></p></div></div></td></tr><tr><td><div><div><p><code>--scopeLoggingConfigFile</code></p></div></div></td><td><div><div><p>Uploads a file to define scope logging.<br>Format: 1 tuple per line, style: <code>{scope: scopeName, logLevel: logLevelType}</code> enclosed with <code>{}</code> <code>()</code> or <code>[]</code></p></div></div></td><td><div><div><p><code>--scopeLoggingConfigFile /Users/mule/Documents/cert.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>--updateStrategy</code></p></div></div></td><td><div><div><p>Updates the strategy used.<br>Default: <code>rolling</code></p></div></div></td><td><div><div><p><code>--updateStrategy recreate</code></p></div></div></td></tr></tbody></table>

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

## runtime-mgr:application:start

\> runtime-mgr:application:start \[flags\] <appid>

Starts running the application specified in `<appid>`. To get this ID, run the
`runtime-mgr application list` command.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:application:stop

\> runtime-mgr:application:stop \[flags\] <appID>

Stops running the application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:application:logs

\> runtime-mgr:application:logs \[flags\] <appID> <specID>

Tails application logs for the application specificied in `<appID>` from the specification specified
in `<specID>`.

To get the `<appID>`, run the `runtime-mgr application list` command.

To get the `<specID>`, run the `runtime-mgr application describe` command.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=2fdc1f4e433859249ea9244c6f708c4e49299ab293873fdbb3a68f07f30c6ef2 url=/mulesoft/current/en-us/anypoint-cli/3.x/cloudhub-apps.md -->

---
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).

<!-- document id=c14e2a65b8a027fdcef7b55cd5bbc33aef820c9157b3f3401c95dba56ad671a0 url=/mulesoft/current/en-us/anypoint-cli/latest/cloudhub-apps.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for CloudHub Applications

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

Use the `cloudhub` commands to automate your CloudHub Applications processes. For more information
about how to use these commands, refer to the [CloudHub documentation](https://docs.mulesoft.com/cloudhub/).

<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-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-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-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><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>Deletes 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>Deploys a new application</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>Shows application details</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-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-modify">runtime-mgr:cloudhub-application:modify</a></p></div></div></td><td><div><div><p>Modifies an existing application, optionally updating the ZIP file</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>Restarts 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>Starts an application</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>Stops a running application</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="#cloudhub-region-list">cloudhub:region:list</a></p></div></div></td><td><div><div><p>Lists all supported regions</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-runtime-list">cloudhub:runtime:list</a></p></div></div></td><td><div><div><p>Lists all available runtimes</p></div></div></td></tr></tbody></table>

## runtime-mgr:cloudhub-alert-history:describe

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

Describes the history of the alarm passed in `<name>`

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-alert:list

\> runtime-mgr:cloudhub-alert:list \[flags\]

Lists all alerts associated with your current environment

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-application:copy

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

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 flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--property</code></p></div></div></td><td><div><div><p>Set a property (<code>name:value</code>).</p></div></div></td><td><div><div><p><code>--property "salesforce.password:qa\=34534"</code></p></div></div></td></tr></tbody></table>

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

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

## runtime-mgr:cloudhub-application:delete

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

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 the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-application:deploy

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

Deploys the Mule deployable archive ZIP file that you specify in `<zipfile>` using the name you set
in `<name>`  
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.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--runtime</code></p></div></div></td><td><div><div><p>Name and version of the runtime environment.<br>Use this flag to specify the name and version of the runtime you want to deploy<br>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>.</p></div></div></td><td><div><div><p><code>--runtime 2.1.1-API-Gateway</code>, <code>--runtime 4.6-e-java8</code> (Edge), <code>--runtime 4.6-e-java17</code> (Edge), <code>--runtime 4.6-java8</code> (LTS), <code>--runtime 4.6-java17</code> (LTS)</p></div></div></td></tr><tr><td><div><div><p><code>--releaseChannel</code></p></div></div></td><td><div><div><p>Set the name of the release channel to be used for the selected Mule version<br>Supported values are <code>NONE</code>, <code>EDGE</code>, and <code>LTS</code><br>If you don’t specify a value, CloudHub API imposes the default value. The default release channel is <code>EDGE</code><br>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><td><div><div><p><code>--releaseChannel EDGE</code></p></div></div></td></tr><tr><td><div><div><p><code>--javaVersion</code></p></div></div></td><td><div><div><p>Set the name of the Java version to be used for the selected Mule version<br>Supported values are <code>8</code> and <code>17</code><br>If you don’t specify a value, CloudHub API imposes the default value. The default Java version for Mule 4.6 and earlier versions is '8'.<br>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><td><div><div><p><code>--javaVersion 8</code></p></div></div></td></tr><tr><td><div><div><p><code>--workers</code></p></div></div></td><td><div><div><p>Number of workers<br>Default value is '1'</p></div></div></td><td><div><div><p><code>--workers 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--workerSize</code></p></div></div></td><td><div><div><p>Size of the workers in vCores<br>(Default value is '1'</p></div></div></td><td><div><div><p><code>--workerSize 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--region</code></p></div></div></td><td><div><div><p>Name of the region to deploy to</p></div></div></td><td><div><div><p><code>--region Canada</code></p></div></div></td></tr><tr><td><div><div><p><code>--property</code></p></div></div></td><td><div><div><p>Set a property (<code>name:value</code>)<br>Character <code>:</code> is not supported for the property’s name</p></div></div></td><td><div><div><p><code>--property "salesforce.password:qa\=34534"</code></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<br>The file format is 1 or more lines in <code>name:value</code> format<br>Set the absolute path of the properties file in your local hard drive</p></div></div></td><td><div><div><p><code>--propertiesFile exampleFile.JSON</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]persistentQueues</code></p></div></div></td><td><div><div><p>Enable or disable persistent queues<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]persistentQueues</code></p></div></div></td></tr><tr><td><div><div><p>`--[no-]persistentQueuesEncrypted `</p></div></div></td><td><div><div><p>Enable or disable persistent queue encryption<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]persistentQueuesEncrypted</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]staticIPsEnabled</code></p></div></div></td><td><div><div><p>Enable or disable static IPs<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]staticIPsEnabled</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV1</code></p></div></div></td><td><div><div><p>Enable or disable Object Store V<br><code>objectStoreV2</code> can’t also be provided when using <code>objectStoreV1</code> flag</p></div></div></td><td><div><div><p><code>--[no-]objectStoreV1</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td><td><div><div><p>Enable or disable Object Store V2<br><code>objectStoreV1</code> can’t also be provided when using <code>objectStoreV2</code> flag</p></div></div></td><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]autoRestart</code></p></div></div></td><td><div><div><p>Automatically restart app when not responding<br>Default value is <code>enabled</code></p></div></div></td><td><div><div><p><code>--[no-]autoRestart</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specify the response format<br>Supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--timeout</code></p></div></div></td><td><div><div><p>Set the timeout value in miliseconds<br>Can take values between <code>60000</code> and <code>300000</code></p></div></div></td><td><div><div><p><code>--timeout 90000</code></p></div></div></td></tr></tbody></table>

> [!NOTE] You won’t be able to allocate static IPs Anypoint Platform CLI. You can simply enable and
> disable them.

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

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

## runtime-mgr:cloudhub-application:describe

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

Displays information on the application you pass in `<name>`  
Use the flag `-o json` to get the raw JSON response of the application you specify in `<name>`.  
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.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-application:download-logs

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

Downloads logs the for application specified in `<name>` to the specified directory

Contrarily to what you see in the UI, the logs you download from the CLI won’t separate system logs
from worker logs.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-application:list

\> runtime-mgr:cloudhub-application:list \[flags\]

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.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-application:modify

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

Updates the settings of an existing application  
Optionally, you can update it by uploading a new ZIP file. This command can take all the same flags
as the `deploy` command.

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

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--runtime</code></p></div></div></td><td><div><div><p>Name and version of the runtime environment.<br>Use this flag to specify the name and version of the runtime you want to deploy<br>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>.</p></div></div></td><td><div><div><p><code>--runtime 2.1.1-API-Gateway</code>, <code>--runtime 4.6-e-java8</code> (Edge), <code>--runtime 4.6-e-java17</code> (Edge), <code>--runtime 4.6-java8</code> (LTS), <code>--runtime 4.6-java17</code> (LTS)</p></div></div></td></tr><tr><td><div><div><p><code>--releaseChannel</code></p></div></div></td><td><div><div><p>Set the name of the release channel to be used for the selected Mule version<br>Supported values are <code>NONE</code>, <code>EDGE</code>, and <code>LTS</code><br>If you don’t specify a value, CloudHub API imposes the default value. The default release channel is <code>EDGE</code><br>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><td><div><div><p><code>--releaseChannel EDGE</code></p></div></div></td></tr><tr><td><div><div><p><code>--javaVersion</code></p></div></div></td><td><div><div><p>Set the name of the Java version to be used for the selected Mule version<br>Supported values are <code>8</code> and <code>17</code><br>If you don’t specify a value, CloudHub API imposes the default value. The default Java version for Mule 4.6 and earlier versions is '8'.<br>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><td><div><div><p><code>--javaVersion 8</code></p></div></div></td></tr><tr><td><div><div><p><code>--workers</code></p></div></div></td><td><div><div><p>Number of workers<br>Default value is '1'</p></div></div></td><td><div><div><p><code>--workers 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--workerSize</code></p></div></div></td><td><div><div><p>Size of the workers in vCores<br>(Default value is '1'</p></div></div></td><td><div><div><p><code>--workerSize 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--region</code></p></div></div></td><td><div><div><p>Name of the region to deploy to</p></div></div></td><td><div><div><p><code>--region Canada</code></p></div></div></td></tr><tr><td><div><div><p><code>--property</code></p></div></div></td><td><div><div><p>Set a property (<code>name:value</code>)<br>Character <code>:</code> is not supported for the property’s name</p></div></div></td><td><div><div><p><code>--property "salesforce.password:qa\=34534"</code></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<br>The file format is 1 or more lines in <code>name:value</code> format<br>Set the absolute path of the properties file in your local hard drive</p></div></div></td><td><div><div><p><code>--propertiesFile exampleFile.JSON</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]persistentQueues</code></p></div></div></td><td><div><div><p>Enable or disable persistent queues<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]persistentQueues</code></p></div></div></td></tr><tr><td><div><div><p>`--[no-]persistentQueuesEncrypted `</p></div></div></td><td><div><div><p>Enable or disable persistent queue encryption<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]persistentQueuesEncrypted</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]staticIPsEnabled</code></p></div></div></td><td><div><div><p>Enable or disable static IPs<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]staticIPsEnabled</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV1</code></p></div></div></td><td><div><div><p>Enable or disable Object Store V<br><code>objectStoreV2</code> can’t also be provided when using <code>objectStoreV1</code> flag</p></div></div></td><td><div><div><p><code>--[no-]objectStoreV1</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td><td><div><div><p>Enable or disable Object Store V2<br><code>objectStoreV1</code> can’t also be provided when using <code>objectStoreV2</code> flag</p></div></div></td><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]autoRestart</code></p></div></div></td><td><div><div><p>Automatically restart app when not responding<br>Default value is <code>enabled</code></p></div></div></td><td><div><div><p><code>--[no-]autoRestart</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specify the response format<br>Supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--timeout</code></p></div></div></td><td><div><div><p>Set the timeout value in miliseconds<br>Can take values between <code>60000</code> and <code>300000</code></p></div></div></td><td><div><div><p><code>--timeout 90000</code></p></div></div></td></tr></tbody></table>

## runtime-mgr:cloudhub-application:restart

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

Restarts the running application you specify in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-application:start

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

Starts the running application you specify in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-application:stop

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

Stops the running application you specify in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cloudhub-application:tail-logs

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

Tails application logs

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:region:list

\> cloudhub:region:list \[flags\]

Lists all supported regions

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:runtime:list

\> cloudhub:runtime:list \[flags\]

Lists all supported runtimes

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=c8d0967065f52434fc5a1bfab93c577de713fac2fda62842f3338efd0295da13 url=/mulesoft/current/en-us/anypoint-cli/3.x/cloudhub-dlb.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for CloudHub Dedicated Load Balancers

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

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#cloudhub-load-balancer-list">cloudhub load-balancer list</a></p></div></div></td><td><div><div><p>Lists all load balancers in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-describe">cloudhub load-balancer describe</a></p></div></div></td><td><div><div><p>Show load balancer details</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-describe-json">cloudhub load-balancer describe-json</a></p></div></div></td><td><div><div><p>Show load balancer details in raw JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-create">cloudhub load-balancer create</a></p></div></div></td><td><div><div><p>Create a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-start">cloudhub load-balancer start</a></p></div></div></td><td><div><div><p>Starts a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-stop">cloudhub load-balancer stop</a></p></div></div></td><td><div><div><p>Stops a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-delete">cloudhub load-balancer delete</a></p></div></div></td><td><div><div><p>Delete a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-add">cloudhub load-balancer ssl-endpoint add</a></p></div></div></td><td><div><div><p>Add an additional certificate to an existing load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-remove">cloudhub load-balancer ssl-endpoint remove</a></p></div></div></td><td><div><div><p>Remove a certificate from a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-set-default">cloudhub load-balancer ssl-endpoint set-default</a></p></div></div></td><td><div><div><p>Set the default certificate that the load balancer will serve</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-describe">cloudhub load-balancer ssl-endpoint describe</a></p></div></div></td><td><div><div><p>Show the load balancer configuration for a particular certificate</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-whitelist-add">cloudhub load-balancer whitelist add</a></p></div></div></td><td><div><div><p>Add an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-whitelist-remove">cloudhub load-balancer whitelist remove</a></p></div></div></td><td><div><div><p>Remove an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-allowlist-add">cloudhub load-balancer allowlist add</a></p></div></div></td><td><div><div><p>Add an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-allowlist-remove">cloudhub load-balancer allowlist remove</a></p></div></div></td><td><div><div><p>Remove an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-mappings-describe">cloudhub load-balancer mappings describe</a></p></div></div></td><td><div><div><p>Lists the proxy mapping rules for a load balancer. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-mappings-add">cloudhub load-balancer mappings add</a></p></div></div></td><td><div><div><p>Add a proxy mapping rule at the specified index. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-mappings-remove">cloudhub load-balancer mappings remove</a></p></div></div></td><td><div><div><p>Remove a proxy mapping rule. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown.</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-dynamic-ips-enable">cloudhub load-balancer dynamic-ips enable</a></p></div></div></td><td><div><div><p>Enables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-dynamic-ips-disable">cloudhub load-balancer dynamic-ips disable</a></p></div></div></td><td><div><div><p>Disables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-region-list">cloudhub region list</a></p></div></div></td><td><div><div><p>Lists all supported regions</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-runtime-list">cloudhub runtime list</a></p></div></div></td><td><div><div><p>Lists all available runtimes</p></div></div></td></tr></tbody></table>

## cloudhub load-balancer list

\> cloudhub load-balancer list \[options\]

This command lists all load balancers in your Anypoint Platform. It displays load balancer’s name,
domain, its state, and the Anypoint VPC ID to which the load balancer is bound.

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

## cloudhub load-balancer describe

\> cloudhub load-balancer describe \[options\] <name>

This command displays information about the load balancer that is specified in `<name>`.

You can start typing your load balancer’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.

It displays load balancer’s name, domain, its state and the Anypoint VPC Id to which the load
balancer is bound.

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

## cloudhub load-balancer describe-json

\> cloudhub load-balancer describe \[options\] <name>

This command displays a raw JSON response from the load balancer that is specified in `<name>`.

You can start typing your load balancer’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`.

## cloudhub load-balancer create

\> cloudhub load-balancer create \[options\] <vpc> <name> <certificate> <privateKey>

This command creates a load balancer using the specified values in the variables.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><p><code>vpc</code></p></td><td><div><div><p>Name of the Anypoint VPC to which this load balancer is bound.<br>If your Anypoint VPC name contains spaces, you need to pass it between ´"´ characters.</p></div></div></td><td><div><div><p><code>vpc-demo</code></p></div></div></td></tr><tr><td><p><code>name</code></p></td><td><div><div><p>Name for the load balancer.</p></div></div></td><td><div><div><p><code>newtestloadbalancer</code></p></div></div></td></tr><tr><td><p><code>certificate</code></p></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your server certificate in your local hard drive.<br>Your certificate files need to be PEM encoded and not encrypted.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.pem</code></p></div></div></td></tr><tr><td><p><code>privateKey</code></p></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your private key of the server certificate in your local hard drive.<br>Your private key file needs to be passphraseless.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/privateKey.pem</code></p></div></div></td></tr></tbody></table>

> [!CAUTION] The name for the load balancer that you pass in `<name>` must be unique.  
> By default, your load balancer listens external requests on HTTPS and communicates with your
> workers internally through HTTP.  
> If you configured your Mule application within the Anypoint VPC to listen on HTTPS, make sure you
> set `upstreamProtocol` to HTTPS when creating the mapping list using the
> [load-balancer mappings add](#cloudhub-load-balancer-mappings-add) command.

Besides 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><code>http</code></p></div></div></td><td><div><div><p>Specifies the Load balancer HTTP behavior. It can be set to <code>on</code> (accepts HTTP requests and forwards it to your configured default <code><em>sslendpoint</em></code>), <code>off</code> (refuses all HTTP requests), or <code>redirect</code> (redirects to HTTPS).</p></div></div></td></tr><tr><td><div><div><p><code>clientCertificate</code></p></div></div></td><td><div><div><p>Client certificate file</p></div></div></td></tr><tr><td><div><div><p><code>verificationMode</code></p></div></div></td><td><div><div><p>Specifies the client verification mode. It can be set to <code>on</code> (verify always), <code>off</code> (don’t verify), or <code>optional</code> (verification optional).</p></div></div></td></tr><tr><td><div><div><p><code>crl</code></p></div></div></td><td><div><div><p>Certificate revocation list file</p></div></div></td></tr><tr><td><div><div><p><code>--transportDownstreamProtocols</code></p></div></div></td><td><div><div><p>TLS version used for communication between customer and DLB<br>Supported values: <code>TLSv1.2</code>, <code>TLSv1.3</code></p></div></div></td></tr><tr><td><div><div><p><code>--transportDownstreamProtocols=TLSv1.2</code></p></div></div></td><td><div><div><p><code>--transportUpstreamProtocols</code></p></div></div></td></tr><tr><td><div><div><p>TLS version used for communication between DLB and Mule worker<br>Supported values: <code>TLSv1.2</code>, <code>TLSv1.3</code></p></div></div></td><td><div><div><p><code>--transportUpstreamProtocols=TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>dynamic-ips</code></p></div></div></td><td><div><div><p>Uses dynamic IPs, which are not persistent through restarts</p></div></div></td></tr></tbody></table>

> [!NOTE] CloudHub does not implement the Online Certificate Status Protocol (OCSP). To keep your
> certification revocation list up to date, it’s recommended to use the
> [CloudHub API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/)
> to update your certificates programmatically.

For more configuration information, see
[Configure SSL Endpoints and Certificates](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints).

## cloudhub load-balancer start

\> cloudhub load-balancer start \[options\] <name>

This command starts the load balancer specified in `<name>`.  
This command does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## cloudhub load-balancer stop

\> cloudhub load-balancer stop \[options\] <name>

This command stops the load balancer specified in `<name>`.  
This command does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## cloudhub load-balancer delete

\> cloudhub load-balancer delete \[options\] <name>

This command deletes the load balancer specified 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 does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## cloudhub load-balancer ssl-endpoint add

\> cloudhub load-balancer ssl-endpoint add \[options\] <name> <certificate> <privateKey>

This command adds an SSL endpoint to the load balancer specified in `<name>`, using the certificate
and private key passed.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Name for the load balancer.</p></div></div></td><td><div><div><p><code>newtestloadbalancer</code></p></div></div></td></tr><tr><td><div><div><p><code>certificate</code></p></div></div></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your certificate in your local hard drive.<br>Your certificate files need to be PEM encoded and not encrypted.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>privateKey</code></p></div></div></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your private key in your local hard drive.<br>Your private key file needs to be passphraseless.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/privateKey.pem</code></p></div></div></td></tr></tbody></table>

> [!NOTE] CloudHub does not implement the Online Certificate Status Protocol (OCSP). To keep your
> certification revocation list up to date, it’s recommended to use the
> [CloudHub API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/)
> to update your certificates programmatically.

Besides 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>clientCertificate</p></div></div></td><td><div><div><p>Client certificate file</p></div></div></td></tr><tr><td><div><div><p>verificationMode</p></div></div></td><td><div><div><p>Specifies the client verification mode. It can be set to <code>on</code> (verify always) <code>off</code> (don’t verify) or <code>optional</code> (Verification optional).</p></div></div></td></tr><tr><td><div><div><p>crl</p></div></div></td><td><div><div><p>Certificate Revocation List file</p></div></div></td></tr></tbody></table>

For more configuration information, see
[Configure SSL Endpoints and Certificates](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints).

## cloudhub load-balancer ssl-endpoint remove

\> cloudhub load-balancer ssl-endpoint remove \[options\] <name> <certificateName>

This command removes the ssl certificate specified in `<certificateName>` from the load balancer
specified 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 does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## cloudhub load-balancer ssl-endpoint set-default

\> cloudhub load-balancer ssl-endpoint set-default \[options\] <name> <certificateName>

This command sets the certificate specified in `<certificateName>` as the default certificate for
the load balancer passed in `<name>`.

You can start typing your load balancer’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.  
Besides 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><code>http</code></p></div></div></td><td><div><div><p>Specifies the Load balancer HTTP behavior</p></div></div></td></tr></tbody></table>

## cloudhub load-balancer ssl-endpoint describe

\> cloudhub load-balancer ssl-endpoint describe \[options\] <name> <certificateName>

This command shows information about the configuration of the load balancer passed in `<name>` for
the the certificate specified in `<certificateName>`.  
You can start typing your load balancer’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 does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## cloudhub load-balancer whitelist add

\> cloudhub load-balancer whitelist add \[options\] <name> <cidrBlock>

This command adds a range of IP addresses specified in `<cidrBlock>` to the allowlist of the load
balancer specified in `<name>`.

> [!NOTE] The allowlist works at the load balancer level, not at the CN certificate level. Make sure
> you only pass IP addresses formatted in
> [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks).

You can start typing your load balancer’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 does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## cloudhub load-balancer whitelist remove

\> cloudhub load-balancer whitelist remove <name> <cidrBlock>

This command removes an IP or range of IPs addresses specified in `<cidrBlock>` to the allowlist of
the load balancer specified 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 does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## cloudhub load-balancer allowlist add

\> cloudhub load-balancer allowlist add \[options\] <name> <cidrBlock>

This command adds a range of IP addresses specified in `<cidrBlock>` to the allowlist of the load
balancer specified in `<name>`.

> [!NOTE] The allowlist works at the load balancer level, not at the CN certificate level. Make sure
> you only pass IP addresses formatted in
> [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks).

You can start typing your load balancer’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 does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

> [!NOTE] We favor the use of the term "allowlist" in adherence to our Inclusive Product Language
> Program.

## cloudhub load-balancer allowlist remove

\> cloudhub load-balancer allowlist remove <name> <cidrBlock>

This command removes an IP or range of IPs addresses specified in `<cidrBlock>` to the allowlist of
the load balancer specified 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 does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

> [!NOTE] We favor the use of the term "allowlist" in adherence to our Inclusive Product Language
> Program.

## cloudhub load-balancer mappings describe

\> cloudhub load-balancer mappings describe <name> \[certificateName\]

This command lists the mapping rules for the load balancer specified in `<name>`.  
If no `certificateName` is passed, Anypoint Platform CLI returns the mappings for the default SSL
endpoint.

This command does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output`

## cloudhub load-balancer mappings add

\> cloudhub load-balancer mappings add \[options\] <name> <inputUri> <appName> <appUri>
\[certificateName\]

This command adds a proxy mapping rule to the load balancer specified in `<name>` in the CN passed
under the `certificateName` option.  
If no `certificateName` is passed, Anypoint Platform CLI adds the mappings to the default SSL
endpoint.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Name of the load balancer to which this rule is applied.</p></div></div></td><td><div><div><p><code>testloadbalancer</code></p></div></div></td></tr><tr><td><div><div><p><code>inputUri</code></p></div></div></td><td><div><div><p>Name of the URI of your input URL</p></div></div></td><td><div><div><p>example.com</p></div></div></td></tr><tr><td><div><div><p><code>appName</code></p></div></div></td><td><div><div><p>Name of the app of your output URL to which the request is forwarded</p></div></div></td><td><div><div><p><code>{app}-example</code></p></div></div></td></tr><tr><td><div><div><p><code>appUri</code></p></div></div></td><td><div><div><p>URI of the app of your output URL to which the request is forwarded</p></div></div></td><td><div><div><p>/</p></div></div></td></tr></tbody></table>

For the values in the example above, for an input call to
`my-superapp.api.example.com/status?limit=10`, the endpoint `my-superapp-example: /status?limit=10`
will be called for the application.

This command also takes the `--upstreamProtocol` option. The `--upstreamProtocol` option sets the
protocol used by your application to communicate internally with your load balancer. If no upstream
protocol is set, HTTP is used as default.

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--upstreamProtocol &lt;protocol&gt;</code></p></div></div></td><td><div><div><p>Look for upstream applications in HTTP port 8091 or HTTPS port 8092. Supported Values: <code>http</code>, <code>https</code></p></div></div></td></tr><tr><td><div><div><p><code>--certificateName &lt;certificate name&gt;</code></p></div></div></td><td><div><div><p>Optional parameter</p></div></div></td></tr></tbody></table>

## cloudhub load-balancer mappings remove

\> cloudhub load-balancer mappings remove \[options\] <name> <index> \[certificateName\]

This command removes the proxy mapping rules from the load balancer specified in `<name>` at the
priority index specified in `<index>` and the CN specified as the `certificateName` option.

This command does not take any options, except for the default ones: `--help`, `-f`/`--fields` and
`-o`/`--output` If no `certificateName` is passed, Anypoint Platform CLI removes the mappings for
the default SSL endpoint.

## cloudhub load-balancer dynamic-ips enable

\> cloudhub load-balancer dynamic-ips enable \[options\] <name>

This command enables dynamic IPs for the load balancer specified in `<name>`. This command does not
take any options, except for the default ones: `--help`, `-f`/`--fields` and `-o`/`--output`

## cloudhub load-balancer dynamic-ips disable

\> cloudhub load-balancer dynamic-ips disable \[options\] <name>

This command disables dynamic IPs for the load balancer specified in `<name>`. This command does not
take any options, except for the default ones: `--help`, `-f`/`--fields` and `-o`/`--output`

## cloudhub region list

\> cloudhub region list \[options\]

This command lists all supported regions.

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

## cloudhub runtime list

\> cloudhub runtime list \[options\]

This command lists all supported runtimes.

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

<!-- document id=ebc180dffac8200fad4dd006d6303601559cf7c1b96464152769b2b4ac2802ec url=/mulesoft/current/en-us/anypoint-cli/latest/cloudhub-dlb.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for CloudHub Dedicated Load Balancers

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

Use the `cloudhub:load-balancer` commands to automate your CloudHub Dedicated Load Balancers
processes. For more information about how to use these commands, refer to the
[CloudHub documentation](https://docs.mulesoft.com/cloudhub/).

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#cloudhub-load-balancer-allowlist-add">cloudhub:load-balancer:allowlist:add</a></p></div></div></td><td><div><div><p>Adds an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-allowlist-remove">cloudhub:load-balancer:allowlist:remove</a></p></div></div></td><td><div><div><p>Removes an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-create">cloudhub:load-balancer:create</a></p></div></div></td><td><div><div><p>Creates a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-delete">cloudhub:load-balancer:delete</a></p></div></div></td><td><div><div><p>Deletes a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-describe">cloudhub:load-balancer:describe</a></p></div></div></td><td><div><div><p>Shows load balancer details</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-dynamic-ips-disable">cloudhub:load-balancer:dynamic-ips:disable</a></p></div></div></td><td><div><div><p>Disables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-dynamic-ips-enable">cloudhub:load-balancer:dynamic-ips:enable</a></p></div></div></td><td><div><div><p>Enables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-list">cloudhub:load-balancer:list</a></p></div></div></td><td><div><div><p>Lists all load balancers in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-mappings-add">cloudhub:load-balancer:mappings:add</a></p></div></div></td><td><div><div><p>Adds a proxy mapping rule at the specified index</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-mappings-describe">cloudhub:load-balancer:mappings:describe</a></p></div></div></td><td><div><div><p>Lists the proxy mapping rules for a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-mappings-remove">cloudhub:load-balancer:mappings:remove</a></p></div></div></td><td><div><div><p>Removes a proxy mapping rule</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-add">cloudhub:load-balancer:ssl-endpoint:add</a></p></div></div></td><td><div><div><p>Adds an additional certificate to an existing load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-describe">cloudhub:load-balancer:ssl-endpoint:describe</a></p></div></div></td><td><div><div><p>Shows the load balancer configuration for a particular certificate</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-remove">cloudhub:load-balancer:ssl-endpoint:remove</a></p></div></div></td><td><div><div><p>Removes a certificate from a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-set-default">cloudhub:load-balancer:ssl-endpoint:set-default</a></p></div></div></td><td><div><div><p>Sets the default certificate that the load balancer will serve</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-start">cloudhub:load-balancer:start</a></p></div></div></td><td><div><div><p>Starts a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-stop">cloudhub:load-balancer:stop</a></p></div></div></td><td><div><div><p>Stops a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-whitelist-add">cloudhub:load-balancer:whitelist:add</a></p></div></div></td><td><div><div><p>Adds an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-whitelist-remove">cloudhub:load-balancer:whitelist:remove</a></p></div></div></td><td><div><div><p>Removes an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr></tbody></table>

## cloudhub:load-balancer:allowlist:add

\> cloudhub:load-balancer:allowlist:add \[flags\] <name> <cidrBlock>

Adds a range of IP addresses specified in `<cidrBlock>` to the allowlist of the load balancer
specified in `<name>`

> [!NOTE] The allowlist works at the load balancer level, not at the CN certificate level. Make sure
> you only pass IP addresses formatted in
> [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks).

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:allowlist:remove

\> cloudhub:load-balancer:allowlist:remove <name> <cidrBlock>

Removes an IP or range of IPs addresses specified in `<cidrBlock>` to the allowlist of the load
balancer specified 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 the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:create

\> cloudhub:load-balancer:create \[flags\] <vpc> <name> <certificate> <privateKey>

Creates a load balancer using the specified values in the following variables:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><p><code>vpc</code></p></td><td><div><div><p>Name of the Anypoint VPC to which this load balancer is bound.<br>If your Anypoint VPC name contains spaces, you need to pass it between ´"´ characters.</p></div></div></td><td><div><div><p><code>vpc-demo</code></p></div></div></td></tr><tr><td><p><code>name</code></p></td><td><div><div><p>Name for the load balancer.</p></div></div></td><td><div><div><p><code>newtestloadbalancer</code></p></div></div></td></tr><tr><td><p><code>certificate</code></p></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your server certificate in your local hard drive.<br>Your certificate files need to be PEM encoded and not encrypted.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.pem</code></p></div></div></td></tr><tr><td><p><code>privateKey</code></p></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your private key of the server certificate in your local hard drive.<br>Your private key file needs to be passphraseless.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/privateKey.pem</code></p></div></div></td></tr></tbody></table>

> [!CAUTION] The name for the load balancer that you pass in `<name>` must be unique.  
> By default, your load balancer listens external requests on HTTPS and communicates with your
> workers internally through HTTP.  
> If you configured your Mule application within the Anypoint VPC to listen on HTTPS, make sure you
> set `upstreamProtocol` to HTTPS when creating the mapping list using the
> [load-balancer mappings add](#cloudhub-load-balancer-mappings-add) command.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--clientCertificate</code></p></div></div></td><td><div><div><p>Client certificate file</p></div></div></td><td><div><div><p><code>--clientCertificate /Users/mule/Documents/CertificateFile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--crl</code></p></div></div></td><td><div><div><p>Certificate revocation list file</p></div></div></td><td><div><div><p><code>--crl /Users/mule/Documents/crlFile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--http</code></p></div></div></td><td><div><div><p>Specifies the Load balancer HTTP behavior. It can be set to <code>on</code> (accepts HTTP requests and forwards it to your configured default <code><em>sslendpoint</em></code>), <code>off</code> (refuses all HTTP requests), or <code>redirect</code> (redirects to HTTPS).</p></div></div></td><td><div><div><p><code>--http off</code></p></div></div></td></tr><tr><td><div><div><p><code>--transportDownstreamProtocols</code></p></div></div></td><td><div><div><p>TLS version used for communication between customer and DLB<br>Supported values: <code>TLSv1.2</code>, <code>TLSv1.3</code></p></div></div></td><td><div><div><p><code>--transportDownstreamProtocols=TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--transportUpstreamProtocols</code></p></div></div></td><td><div><div><p>TLS version used for communication between DLB and Mule worker<br>Supported values: <code>TLSv1.2</code>, <code>TLSv1.3</code></p></div></div></td><td><div><div><p><code>--transportUpstreamProtocols=TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]dynamic-ips</code></p></div></div></td><td><div><div><p>Uses dynamic IPs, which are not persistent through restarts</p></div></div></td><td><div><div><p><code>--[no-]dynamic-ips</code></p></div></div></td></tr><tr><td><div><div><p><code>--verificationMode</code></p></div></div></td><td><div><div><p>Specifies the client verification mode. It can be set to <code>on</code> (verify always), <code>off</code> (don’t verify), or <code>optional</code> (verification optional).</p></div></div></td><td><div><div><p><code>--verificationMode optional</code></p></div></div></td></tr></tbody></table>

> [!NOTE] CloudHub does not implement the Online Certificate Status Protocol (OCSP). To keep your
> certification revocation list up to date, it’s recommended to use the
> [CloudHub API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/)
> to update your certificates programmatically.

For more configuration information, see
[Configure SSL Endpoints and Certificates](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints).

## cloudhub:load-balancer:delete

\> cloudhub:load-balancer:delete \[flags\] <name>

Deletes the load balancer specified 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 the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:describe

\> cloudhub:load-balancer:describe \[flags\] <name>

Displays information about the load balancer that is specified in `<name>`  
Use the flag `-o json` to get the raw JSON response of the application you specify in `<name>`  
It displays load balancer’s name, domain, its state and the Anypoint VPC Id to which the load
balancer is bound.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:dynamic-ips:disable

\> cloudhub:load-balancer:dynamic-ips:disable \[flags\] <name>

Disables dynamic IPs for the load balancer specified in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:dynamic-ips:enable

\> cloudhub:load-balancer:dynamic-ips:enable \[flags\] <name>

Enables dynamic IPs for the load balancer specified in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:list

\> cloudhub:load-balancer:list \[flags\]

Lists all load balancers in your Anypoint Platform  
It displays load balancer’s name, domain, its state, and the Anypoint VPC ID to which the load
balancer is bound.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:mappings:add

\> cloudhub:load-balancer:mappings:add \[flags\] <name> <index> <inputUri> <appName> <appUri>
\[certificateName\]

Adds a proxy mapping rule to the load balancer specified in `<name>` in the CN passed under the
`certificateName` flag.  
If no `certificateName` is passed, Anypoint Platform CLI adds the mappings to the default SSL
endpoint.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Name of the load balancer to which this rule is applied.</p></div></div></td><td><div><div><p><code>testloadbalancer</code></p></div></div></td></tr><tr><td><div><div><p><code>inputUri</code></p></div></div></td><td><div><div><p>Name of the URI of your input URL</p></div></div></td><td><div><div><p><code>example.com</code></p></div></div></td></tr><tr><td><div><div><p><code>appName</code></p></div></div></td><td><div><div><p>Name of the app of your output URL to which the request is forwarded</p></div></div></td><td><div><div><p><code>{app}-example</code></p></div></div></td></tr><tr><td><div><div><p><code>appUri</code></p></div></div></td><td><div><div><p>URI of the app of your output URL to which the request is forwarded</p></div></div></td><td><div><div><p>/</p></div></div></td></tr></tbody></table>

For the values in the example above, for an input call to
`my-superapp.api.example.com/status?limit=10`, the endpoint `my-superapp-example: /status?limit=10`
will be called for the application.

If no upstream protocol is set, HTTP is used as default.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p>`--certificateName `</p></div></div></td><td><div><div><p>Certificate name</p></div></div></td><td><div><div><p><code>--certificateName exampleName</code></p></div></div></td></tr><tr><td><div><div><p><code>--upstreamProtocol &lt;protocol&gt;</code></p></div></div></td><td><div><div><p>Set the protocol used by your application to communicate internally with your load balancer<br>Supported Values: <code>http</code>, <code>https</code></p></div></div></td><td><div><div><p><code>--upstreamProtocol http</code></p></div></div></td></tr></tbody></table>

## cloudhub:load-balancer:mappings:describe

\> cloudhub:load-balancer:mappings:describe <name> \[certificateName\]

Lists the mapping rules for the load balancer specified in `<name>`  
If no `certificateName` is passed, Anypoint Platform CLI returns the mappings for the default SSL
endpoint.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:mappings:remove

\> cloudhub:load-balancer:mappings:remove \[flags\] <name> <index> \[certificateName\]

Removes the proxy mapping rules from the load balancer specified in `<name>` at the priority index
specified in `<index>` and the CN specified as the `certificateName` flag  
If no `certificateName` is passed, Anypoint Platform CLI removes the mappings for the default SSL
endpoint.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:ssl-endpoint:add

\> cloudhub:load-balancer:ssl-endpoint:add \[flags\] <name> <certificate> <privateKey>

Adds an SSL endpoint to the load balancer specified in `<name>`, using the certificate and private
key passed:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Name for the load balancer.</p></div></div></td><td><div><div><p><code>newtestloadbalancer</code></p></div></div></td></tr><tr><td><div><div><p><code>certificate</code></p></div></div></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your certificate in your local hard drive.<br>Your certificate files need to be PEM encoded and not encrypted.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>privateKey</code></p></div></div></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your private key in your local hard drive.<br>Your private key file needs to be passphraseless.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/privateKey.pem</code></p></div></div></td></tr></tbody></table>

> [!NOTE] CloudHub does not implement the Online Certificate Status Protocol (OCSP). To keep your
> certification revocation list up to date, it’s recommended to use the
> [CloudHub API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/)
> to update your certificates programmatically.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--clientCertificate</code></p></div></div></td><td><div><div><p>Client certificate file</p></div></div></td><td><div><div><p><code>--clientCertificate /Users/mule/Documents/CertificateFile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--crl</code></p></div></div></td><td><div><div><p>Certificate Revocation List file</p></div></div></td><td><div><div><p><code>--clientCertificate /Users/mule/Documents/crlFile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--verificationMode</code></p></div></div></td><td><div><div><p>Specifies the client verification mode. It can be set to <code>on</code> (verify always) <code>off</code> (don’t verify) or <code>optional</code> (Verification optional).</p></div></div></td><td><div><div><p><code>--verificationMode on</code></p></div></div></td></tr></tbody></table>

For more configuration information, see
[Configure SSL Endpoints and Certificates](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints).

## cloudhub:load-balancer:ssl-endpoint:describe

\> cloudhub:load-balancer:ssl-endpoint:set-describe \[flags\] <name> <certificateName>

Shows information about the configuration of the load balancer passed in `<name>` for the
certificate specified in `<certificateName>`

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:ssl-endpoint:remove

\> cloudhub:load-balancer:ssl-endpoint:remove \[flags\] <name> <certificateName>

Removes the ssl certificate specified in `<certificateName>` from the load balancer specified 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 the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:ssl-endpoint:set-default

\> cloudhub:load-balancer:ssl-endpoint:set-default \[flags\] <name> <certificateName>

Sets the certificate specified in `<certificateName>` as the default certificate for the load
balancer passed in `<name>`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--http</code></p></div></div></td><td><div><div><p>Specifies the Load balancer HTTP behavior<br>It can be set to <code>on</code> (accepts HTTP requests and forwards it to your configured default <code><em>sslendpoint</em></code>), <code>off</code> (refuses all HTTP requests), or <code>redirect</code> (redirects to HTTPS)</p></div></div></td><td><div><div><p><code>--http redirect</code></p></div></div></td></tr></tbody></table>

## cloudhub:load-balancer:start

\> cloudhub:load-balancer:start \[flags\] <name>

Starts the load balancer specified in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:stop

\> cloudhub:load-balancer:stop \[flags\] <name>

Stops the load balancer specified in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:whitelist:add

\> cloudhub:load-balancer:whitelist:add \[flags\] <name> <cidrBlock>

Adds a range of IP addresses specified in `<cidrBlock>` to the allowlist of the load balancer
specified in `<name>`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## cloudhub:load-balancer:whitelist:remove

\> cloudhub:load-balancer:whitelist:remove \[flags\] <name> <cidrBlock>

Removes an IP or range of IPs specified in `<cidrBlock>` from the allowlist of the load balancer
specified in `<name>`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=ec04430ccc1d37c840051c5fdef2f5b0b8635bb31134e5c3c7d40b5fc86bbf4b url=/mulesoft/current/en-us/anypoint-cli/3.x/datagraph-source.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for DataGraph API Source Management

> 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="#datagraph-sources-add">datagraph sources add</a></p></div></div></td><td><div><div><p>Adds an API source</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-sources-promote">datagraph sources promote</a></p></div></div></td><td><div><div><p>Promotes an API source</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-sources-update">datagraph sources update</a></p></div></div></td><td><div><div><p>Updates an API source</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-scale">datagraph scale</a></p></div></div></td><td><div><div><p>Scales API calls made to the unified schema</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-schema-download">datagraph schema-download</a></p></div></div></td><td><div><div><p>Downloads the unified schema</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-sources-delete">datagraph sources delete</a></p></div></div></td><td><div><div><p>Deletes an API source</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-sources-get">datagraph sources get</a></p></div></div></td><td><div><div><p>Gets an API source</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-sources-list">datagraph sources list</a></p></div></div></td><td><div><div><p>Lists all API sources</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-describe">datagraph describe</a></p></div></div></td><td><div><div><p>Returns information about DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-validate">datagraph validate</a></p></div></div></td><td><div><div><p>Validates an API source for the unified schema</p></div></div></td></tr></tbody></table>

## datagraph sources add

\> datagraph sources add <g/a/v>

> [!NOTE] DataGraph supports only `stable` state API versions.

This command adds an API source, specified by `<g/a/v>`, in which `g` is the group ID, `a` the asset
ID, and `v` the version ID of the API source. The group ID is optional. If you don’t specify a group
ID, the command uses the current organization ID.

In addition to the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options, this
command accepts the following options:

<table><colgroup><col> <col></colgroup><thead><tr><th>Options</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--auth-none</code></p></div></div></td><td><div><div><p>Use if your API is public.</p></div></div></td></tr><tr><td><div><div><p><code>--auth-basic</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API either by passing the basic authentication header or by passing a username and password.<br><br>Required:</p></div><div><ul><li><p><code>--credentials &lt;username&gt;:&lt;password&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-oauth</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing OAuth 2.0 <code>client_id</code>, <code>client_secret</code>, and authorization server values.<br><br>Required:</p></div><div><ul><li><p><code>--credentials &lt;client_id&gt;:&lt;client_secret&gt;</code></p></li><li><p><code>--server &lt;authorization server URL&gt;</code><br><br>Not Required:</p></li><li><p><code>--scope &lt;server&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-pass-through</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing authorization headers.<br><br>Required:</p></div><div><ul><li><p><code>--mapping: &lt;comma-separated list of key-value pairs, for example, key1:value1,key2:value2&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-headers</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing custom header parameters and values.<br><br>Required for headers:</p></div><div><ul><li><p><code>--custom-headers: &lt;comma-separated list of header-value pairs, for example, header1:value1,header2:value2&gt;</code></p><div><p>Or</p></div></li><li><p><code>--custom-headers-file: &lt;location of the file containing header-value pairs, one per line&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-query-params</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing query parameters and values.<br><br>Required for query params:</p></div><div><ul><li><p><code>--credentials &lt;client_id:client_secret&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--url &lt;url&gt;</code></p></div></div></td><td><div><div><p>Configures the URL for the backend API.</p></div></div></td></tr><tr><td><div><div><p><code>--discover-url</code></p></div></div></td><td><div><div><p>Automatically discovers the URL of the backend API based on the instances running in the current environment. If more than one API is running, DataGraph uses the first URL.</p></div></div></td></tr><tr><td><div><div><p><code>--ca</code></p></div></div></td><td><div><div><p>Specify a comma-separated list of certificate authority (CA) files to add to the API’s truststore, for example, <code>file.ca,file2.ca</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--cert</code></p></div></div></td><td><div><div><p>Specify the filename of the client certificate to use for mutual transport layer security (mTLS), for example, <code>cert.ca</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--key</code></p></div></div></td><td><div><div><p>Specify the filename of the private key to use for mTLS, for example <code>key.pem</code>.</p></div></div></td></tr><tr><td><div><div><p><code>--key-password</code></p></div></div></td><td><div><div><p>Specify the password to decrypt an encrypted private key.</p></div></div></td></tr><tr><td><div><div><p><code>--ignore-invalid-edits</code></p></div></div></td><td><div><div><p>Use to apply valid edits made in the extensions in the API specification and to ignore any edits that are invalid.</p></div></div></td></tr></tbody></table>

> [!NOTE] All headers and query params defined in the command line, and all header and query param
> files, are appended. If there are repeated keys, the values provided in the command line takes
> precedence.

### Example Command

```copy
datagraph sources add 18dc11ee-4a09-4aae-9c6c-4371a87eafa8/product-api/1.0.0/  --url http://test.com
```

### Example Output

{ "apiVersion": "v1", "assetId": "product-api", "createDate": "2022-05-20T18:05:41", "endpoint":
"http://test.com", "environmentId": "<envID>", "groupId": "<groupID>", "name": "Product API",
"organizationId": "<orgID>", "securityScheme": "NO\_AUTH", "sourceId":
"deca7be1-c299-4441-bc7b-dba733e3a11f", "updateDate": "2022-05-20T18:05:41", "version": "1.0.0",
"origin": "CLI" }

## datagraph sources promote

\> datagraph sources promote <sourceId> <target-EnvID>

This command promotes an API source `<sourceId>` to the target environment `<targetEnv>`.

In addition to the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options, this
command accepts the following options:

<table><colgroup><col> <col></colgroup><thead><tr><th>Options</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--auth-none</code></p></div></div></td><td><div><div><p>Use if your API is public.</p></div></div></td></tr><tr><td><div><div><p><code>--auth-basic</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API either by using the basic authentication header or by using a username and password.<br><br>Required:</p></div><div><ul><li><p><code>--credentials &lt;username&gt;:&lt;password&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-oauth</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing OAuth 2.0 <code>client_id</code>, <code>client_secret</code>, and authorization server values.<br><br>Required:</p></div><div><ul><li><p><code>--client-credentials &lt;client_id&gt;:&lt;client_secret&gt;</code></p></li><li><p><code>--server &lt;authorization server URL&gt;</code><br><br>Not Required:</p></li><li><p><code>--scope &lt;server&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-pass-through</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing authorization headers.<br><br>Required:</p></div><div><ul><li><p><code>--mapping: &lt;comma-separated list of key-value pairs, for example, key1:value1,key2:value2&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-headers</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing custom header parameters and values.<br><br>Required for headers:</p></div><div><ul><li><p><code>--custom-headers: &lt;comma-separated list of header-value pairs, for example, header1:value1,header2:value2&gt;</code></p><div><p>Or</p></div></li><li><p><code>--custom-headers-file: &lt;location of the file containing header header-value pairs, one per line&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-query-params</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing query parameters and values.<br><br>Required for query params:</p></div><div><ul><li><p><code>--credentials &lt;client_id:client_secret&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--url</code></p></div></div></td><td><div><div><p>Configures the URL for the backend API.</p></div></div></td></tr><tr><td><div><div><p><code>--discover-url</code></p></div></div></td><td><div><div><p>Automatically discovers the URL of the backend API based on the instances running in the current environment. If more than one API is running, DataGraph uses the first URL.</p></div></div></td></tr><tr><td><div><div><p><code>--ca</code></p></div></div></td><td><div><div><p>Specify a list of CA files to add to the API’s truststore.</p></div></div></td></tr><tr><td><div><div><p><code>--cert</code></p></div></div></td><td><div><div><p>Specify the client certificate to use for mTLS.</p></div></div></td></tr><tr><td><div><div><p><code>--key</code></p></div></div></td><td><div><div><p>Specify the private key to use for mTLS.</p></div></div></td></tr><tr><td><div><div><p><code>--key-password</code></p></div></div></td><td><div><div><p>Specify the password to decrypt an encrypted private key.</p></div></div></td></tr><tr><td><div><div><p><code>--empty-ca</code></p></div></div></td><td><div><div><p>Deletes all CA certificates.</p></div></div></td></tr><tr><td><div><div><p><code>--empty-mtls</code></p></div></div></td><td><div><div><p>Deletes the client certificate, private key, and private key password information.</p></div></div></td></tr></tbody></table>

> [!NOTE] All headers and query params defined in the command line, and all header and query param
> files, are appended. If there are repeated keys, the values provided in the command line takes
> precedence.

### Example Command

In this example, the `environmentId` is changed after running the `promote` command.

```copy
datagraph sources promote d1d27987-939a-4b41-b3ef-411568ee5bdd e7e8da65-9cf1-569e-c9d2-brd2r0rc7rd6 --auth-none
```

### Example Output

{ "apiVersion": "1.0", "assetId": "order-e2e", "createDate": "2022-05-27T18:56:03", "endpoint":
"http://test.com", "environmentId": "e7e8da65-9cf1-569e-c9d2-brd2r0rc7rd6", "groupId": "<groupID>",
"name": "Order E2E", "organizationId": "<orgID>", "securityScheme": "NO\_AUTH", "sourceId":
"1ff021b3-9296-43fd-9d64-2f9027c25740", "updateDate": "2022-05-27T18:56:03", "version": "1.0.0",
"origin": "CLI" }

## datagraph sources update

\> datagraph sources update <sourceId>

> [!NOTE] DataGraph supports only `stable` state API versions. The `update` command updates only
> patch and minor versions of an API source.

This command updates the version of an API source `<sourceId>`.

In addition to the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options, this
command accepts the following options:

<table><colgroup><col> <col></colgroup><thead><tr><th>Options</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--auth-none</code></p></div></div></td><td><div><div><p>Use if your API is public.</p></div></div></td></tr><tr><td><div><div><p><code>--auth-basic</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing either the basic authentication header or both a username and password.<br><br>Required:</p></div><div><ul><li><p><code>--credentials &lt;username&gt;:&lt;password&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-oauth</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing OAuth 2.0 <code>client_id</code>, <code>client_secret</code>, and authorization server values.<br><br>Required:</p></div><div><ul><li><p><code>--credentials &lt;client_id&gt;:&lt;client_secret&gt;</code></p></li><li><p><code>--server &lt;authorization server URL&gt;</code><br><br>Not Required:</p></li><li><p><code>--scope &lt;server&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-pass-through</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing authorization headers.<br><br>Required:</p></div><div><ul><li><p><code>--mapping: &lt;comma-separated list of key-value pairs, for example, key1:value1,key2:value2&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-headers</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing custom header parameters and values.<br><br>Required for headers:</p></div><div><ul><li><p><code>--custom-headers: &lt;comma-separated list of header-value pairs, for example, header1:value1,header2:value2&gt;</code></p><div><p>Or</p></div></li><li><p><code>--custom-headers-file: &lt;location of the file containing header-value pairs, one per line&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--auth-query-params</code></p></div></div></td><td><div><div><p>Use if you authenticate to your API by passing query parameters and values.<br><br>Required for query params:</p></div><div><ul><li><p><code>--credentials &lt;client_id:client_secret&gt;</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--url</code></p></div></div></td><td><div><div><p>Configures the URL for the backend API.</p></div></div></td></tr><tr><td><div><div><p><code>--discover-url</code></p></div></div></td><td><div><div><p>Automatically discovers the URL of the backend API based on the instances running in the current environment. If more than one API is running, DataGraph uses the first URL.</p></div></div></td></tr><tr><td><div><div><p><code>--ca</code></p></div></div></td><td><div><div><p>Specify a list of CA files to add to the API’s truststore.</p></div></div></td></tr><tr><td><div><div><p><code>--cert</code></p></div></div></td><td><div><div><p>Specify the client certificate to use for mTLS.</p></div></div></td></tr><tr><td><div><div><p><code>--key</code></p></div></div></td><td><div><div><p>Specify the private key to use for mTLS.</p></div></div></td></tr><tr><td><div><div><p><code>--key-password</code></p></div></div></td><td><div><div><p>Specify the password to decrypt an encrypted private key.</p></div></div></td></tr><tr><td><div><div><p><code>--empty-ca</code></p></div></div></td><td><div><div><p>Deletes all CA certificates.</p></div></div></td></tr><tr><td><div><div><p><code>--empty-mtls</code></p></div></div></td><td><div><div><p>Deletes the client certificate, private key, and private key password information.</p></div></div></td></tr><tr><td><div><div><p><code>--keep-edits</code></p></div></div></td><td><div><div><p>Keeps edits that are present in the current version of the API source instead of extracting those edits from the API specification.</p></div></div></td></tr><tr><td><div><div><p><code>--override-ui-edits</code></p></div></div></td><td><div><div><p>Change the origin of the API source to the CLI. Ff the origin of the API source is the DataGraph UI, use this option to override the UI edits with the edits in the API specification.</p></div></div></td></tr><tr><td><div><div><p><code>--ignore-invalid-edits</code></p></div></div></td><td><div><div><p>Use to apply valid edits made in the extensions in the API specification and to ignore any edits that are invalid.</p></div></div></td></tr></tbody></table>

> [!NOTE] All headers and query params defined in the command line, and all header and query param
> files, are appended. If there are repeated keys, the values provided in the command line takes
> precedence.

### Example Command

The following command updates the URL of the source API and changes its authentication from
`auth-none` to `auth-basic`, adding a client ID and secret.

```copy
> datagraph sources update b6cb82a6-51dc-4968-861a-aa04447c3442 --url http://test2.com --version 1.0.0 --auth-basic --credentials client-test:client-secret
```

### Example Output

{ "apiVersion": "v1", "assetId": "product-api", "createDate": "2022-05-20T18:56:57Z", "endpoint":
"http://test2.com", "environmentId": "<envID>", "groupId": "<groupID>", "name": "Product API",
"organizationId": "<orgID>", "securityScheme": "BASIC", "sourceId":
"b6cb82a6-51dc-4968-861a-aa04447c3442", "updateDate": "2022-05-27T18:31:39", "version": "1.0.0",
"origin": "CLI" }

## datagraph scale

\> datagraph scale <concurrent-api-calls>

This command enables you to configure the number of concurrent API calls permitted for a unified
schema. Increasing or decreasing API calls enables you to process higher workloads and optimize your
consumption when needed.

This command takes the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options.

### Example Command

```copy
datagraph scale 300
```

### Example Output

{ "message": "Api calls updated" }

## datagraph schema-download

\> datagraph schema-download

This command downloads the unified schema for the current environment.

This command takes the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options.

### Example Output

directive @key(fields: String) on OBJECT

"An Item" type Item { itemId: Int! "A Product" product: OrderProduct! quantity: Int! }

"An Order" type Order { items: \[Item!\]! orderId: String! customerId: String! }

"A Product" type OrderProduct { productId: String! name: String! }

type Query { orders(ordersCount: Int): \[Order!\] ordersByOrderId(orderId: String!): Order
ordersProductsByOrderId(productsCounts: Int, orderId: String!): \[OrderProduct!\] }

## datagraph sources delete

\> datagraph sources delete <sourceId>

This command deletes the specified API source.

This command takes the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options.

### Example Command

```copy
datagraph sources delete d40df394-785d-4c91-8aeb-f07568dd57c
```

### Example Output

{ "message": "Source deleted successfully", "sourceId": "620afe93-b196-42eb-ae77-b68a0a937b6a" }

## datagraph sources get

\> datagraph sources get <sourceId>

This command gets the specified API source.

This command takes the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options.

### Example Command

```copy
datagraph sources get d1d27987-939a-4b41-b3ef-411568ee5bdd
```

### Example Output

{ "apiVersion": "1.0", "assetId": "order-e2e", "createDate": "2022-05-20T16:49:00Z", "hasKeystore":
false, "endpoint": "http://test.com", "environmentId": "<envID>", "groupId": "<groupID>", "name":
"Order E2E", "organizationId": "<orgID>", "hasTruststore": false, "securityScheme": "NO\_AUTH",
"sourceId": "d1d27987-939a-4b41-b3ef-411568ee5bdd", "updateDate": "2022-05-20T16:49:00Z", "version":
"1.0.0", "origin": "CLI" }

## datagraph sources list

```copy
> datagraph sources list
```

This command lists all API sources for the current environment.

This command takes the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options.

### Example Output

{ "apiVersion": "1.0", "assetId": "order-e2e", "createDate": "2022-05-20T16:49:00.000Z", "endpoint":
"http://test.com", "environmentId": "<envID>", "groupId": "<groupID>", "name": "Order E2E",
"organizationId": "<orgID>", "securityScheme": "NO\_AUTH", "sourceId":
"d1d27987-939a-4b41-b3ef-411568ee5bdd", "updateDate": "2022-05-20T16:49:00.000Z", "version":
"1.0.0", "origin": "CLI" }, { "apiVersion": "v1", "assetId": "product-api", "createDate":
"2022-05-20T18:05:41.000Z", "endpoint": "http://test.com", "environmentId": "<envID>", "groupId":
"<groupID>", "name": "Product API", "organizationId": "<orgID>", "securityScheme": "NO\_AUTH",
"sourceId": "deca7be1-c299-4441-bc7b-dba733e3a11f", "updateDate": "2022-05-20T18:05:41.000Z",
"version": "1.0.0", "origin": "CLI" }

## datagraph describe

```copy
> datagraph describe
```

This command returns the following information about DataGraph:

- `endpoint`: Displays the GraphQL endpoint that accepts requests.

- `deploymentError`: If a DataGraph deployment fails, this field describes the error; otherwise,
  it’s empty.

- `deploymentStatus`: Shows whether DataGraph is deploying, running, or has errors.

- `logLevels`: Displays a list of the configured log levels.

- `envStatus`: Displays the status of the current environment.

- `dlbEndpoint`: Displays the load balancer endpoint.

This command takes the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options.

### Example Output

{ "deploymentStatus": "STARTED", "dlbEndpoint": "datagraph-example.us-e1.prod.cloudhub.io",
"endpoint": "datagraph-example.us-e1.prod.cloudhub.io", "envStatus": "STARTED" }

## datagraph validate

\> datagraph validate asset <g/a/v>

This command validates if it’s possible to add an API source to the unified schema. To do so, the
command:

- Translates the API source into a GraphQL schema.

- Validates any API extensions applied in the API specification.

- Runs a conflict check against the unified schema.

If any of these steps generates a conflict or error, the command returns the result. If it finds no
conflicts or errors, it returns a success message.

The API source to validate is specified by `<g/a/v>`, in which `g` is the group ID, `a` the asset
ID, and `v` the version ID of the API source. The group ID is optional. If you don’t specify a group
ID, the command uses the current organization ID.

This command takes the default `--help`, `-f/--fields`, `-o/--output`, and `--verbose` options.

### Example Command

```copy
datagraph validate asset 73b0d8f2-5a2f-4107-884d-fcd80f30bc51/sales-api/1.0.0
```

### Example Output

{ "code": "success" }

<!-- document id=14a198868f3c2c9b87f650dbe6b6dad030c29a45970ef604f3f8d7f96a4b3e66 url=/mulesoft/current/en-us/anypoint-cli/3.x/datagraph-load-balancer.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for DataGraph Load Balancers

> 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="#datagraph-load-balancer-config-add">datagraph load-balancer-config add</a></p></div></div></td><td><div><div><p>Adds a dedicated load balancer configuration to Anypoint DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-load-balancer-config-describe">datagraph load-balancer-config describe</a></p></div></div></td><td><div><div><p>Displays a dedicated load balancer configuration for Anypoint DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-load-balancer-config-remove">datagraph load-balancer-config remove</a></p></div></div></td><td><div><div><p>Removes a dedicated load balancer configuration from Anypoint DataGraph</p></div></div></td></tr></tbody></table>

## datagraph load-balancer-config add

```copy
> datagraph load-balancer-config add <dlbUrl>
```

This command adds a dedicated load balancer configuration specified by `<dlbUrl>` to Anypoint
DataGraph. The `dlbUrl` is a valid URL that includes the DLB domain and the mapping rule `inputUri`.

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

## datagraph load-balancer-config describe

```copy
> datagraph load-balancer-config describe [options]
```

This command displays a dedicated load balancer URL for Anypoint DataGraph.

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

## datagraph load-balancer-config remove

```copy
> datagraph load-balancer-config remove [options]
```

This command removes a dedicated load balancer configuration from Anypoint DataGraph.

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

<!-- document id=ace51287044e7d5d7513b58de7bc78fae0b9047f80e19469acbfda118de43ea5 url=/mulesoft/current/en-us/anypoint-cli/latest/datagraph-load-balancer.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for DataGraph Load Balancers

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

Use the `datagraph` commands to automate your DataGraph Load Balancers processes. For more
information about how to use these commands, refer to the
[DataGraph documentation](https://docs.mulesoft.com/datagraph/).

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#datagraph-load-balancer-config-add">datagraph:load-balancer-config:add</a></p></div></div></td><td><div><div><p>Adds a dedicated load balancer configuration to Anypoint DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-load-balancer-config-describe">datagraph:load-balancer-config:describe</a></p></div></div></td><td><div><div><p>Displays a dedicated load balancer configuration for Anypoint DataGraph</p></div></div></td></tr><tr><td><div><div><p><a href="#datagraph-load-balancer-config-remove">datagraph:load-balancer-config:remove</a></p></div></div></td><td><div><div><p>Removes a dedicated load balancer configuration from Anypoint DataGraph</p></div></div></td></tr></tbody></table>

## datagraph:load-balancer-config:add

```copy
> datagraph:load-balancer-config:add <dlbUrl>
```

Adds a dedicated load balancer configuration specified by `<dlbUrl>` to Anypoint DataGraph  
The `dlbUrl` is a valid URL that includes the DLB domain and the mapping rule `inputUri`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## datagraph:load-balancer-config:describe

```copy
> datagraph:load-balancer-config:describe [flags]
```

Displays a dedicated load balancer URL for Anypoint DataGraph

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## datagraph:load-balancer-config:remove

```copy
> datagraph:load-balancer-config:remove [flags]
```

Removes a dedicated load balancer configuration from Anypoint DataGraph.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=a930df09f2f2bd40af53758dcbfc9c9072ce8d98f3b12ca93098677c8cc868bd url=/mulesoft/current/en-us/anypoint-cli/3.x/design-center.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Design Center Projects

> 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="#designcenter-project-create">designcenter project create</a></p></div></div></td><td><div><div><p>Creates a new Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-delete">designcenter project delete</a></p></div></div></td><td><div><div><p>Deletes a Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-download">designcenter project download</a></p></div></div></td><td><div><div><p>Downloads the content of a Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-publish">designcenter project publish</a></p></div></div></td><td><div><div><p>Publishes a Design Center project to Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-upload">designcenter project upload</a></p></div></div></td><td><div><div><p>Uploads the content of a project to Design Center</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-list">designcenter project list</a></p></div></div></td><td><div><div><p>List all Design Center projects</p></div></div></td></tr></tbody></table>

## designcenter project create

\> designcenter project create \[options\] <name>

This Command creates a new Design Center project with the name specified in `<name>`.

> [!IMPORTANT] This command does not support Mule application types.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--type (required)</code></p></div></div></td><td><div><div><p>The project type.<br>This field is required.</p></div><div><p>Supported values are:</p></div><div><ul><li><p><code>raml</code></p></li><li><p><code>raml-fragment</code></p></li></ul></div></div></td><td><div><div><p><code>designcenter project create --type raml</code></p></div></div></td></tr><tr><td><div><div><p><code>--fragment-type</code></p></div></div></td><td><div><div><p>The fragment type. Always use with <code>--type raml-fragment</code>, even for OAS 3.0 and JSON schema fragments.</p></div><div><p>This field is required if the type option was set as <code>raml-fragment</code></p></div><div><p>Supported fragments type are:</p></div><div><ul><li><p><code>trait</code></p></li><li><p><code>resource-type</code></p></li><li><p><code>library</code></p></li><li><p><code>type</code></p></li><li><p><code>user-documentation</code></p></li><li><p><code>oas-components</code></p></li><li><p><code>json-schema</code></p></li></ul></div></div></td><td><div><div><p><code>designcenter project create --type raml-fragment --fragment-type user-documentation</code></p></div></div></td></tr></tbody></table>

## designcenter project delete

\> designcenter project delete \[options\] <name>

This Command deletes the Design Center project specified 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`.

## designcenter project download

\> designcenter project download \[options\] <name> <targetDir>

This command downloads the Design Center project passed in `name` to your local directory specified
in `targetDir`.

Use the `--branch` option to select the branch you want to download content from. Use the
`--resolveDependenciesTimeout=X` flag to specify the duration, in minutes, for the commands to wait
for the resolution of dependencies before downloading a project. If the specified time passes, your
project downloads without the missing dependencies.

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

## designcenter project publish

\> designcenter project publish \[options\] <projectName>

This Command publishes the Design Center project passed in `projectName` to Exchange.  
Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes:

> [!TIP] Options that are not specified are extracted from exchange.json

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>The name for the asset</p></div></div></td><td><div><div><p><code>designcenter project publish --name sampleProject</code></p></div></div></td></tr><tr><td><div><div><p><code>--main</code></p></div></div></td><td><div><div><p>The name of the main file name.</p></div></div></td><td><div><div><p><code>designcenter project publish --main sample.xml</code></p></div></div></td></tr><tr><td><div><div><p><code>--apiVersion</code></p></div></div></td><td><div><div><p>The API version if your project is an API specification project.</p></div></div></td><td><div><div><p><code>designcenter project publish --main sample.raml --apiVersion 1.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--tags</code></p></div></div></td><td><div><div><p>Comma separated list of tags.</p></div></div></td><td><div><div><p><code>designcenter project publish --tags test,sample,integration</code></p></div></div></td></tr><tr><td><div><div><p><code>--groupId</code></p></div></div></td><td><div><div><p>The asset’s groupId.</p></div></div></td><td><div><div><p><code>designcenter project publish --groupId com.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--assetId</code></p></div></div></td><td><div><div><p>The asset’s assetId.</p></div></div></td><td><div><div><p><code>designcenter project publish --assetId project</code></p></div></div></td></tr><tr><td><div><div><p><code>--version</code></p></div></div></td><td><div><div><p>The asset’s version.</p></div></div></td><td><div><div><p><code>designcenter project publish --version 1.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--branch</code></p></div></div></td><td><div><div><p>The asset’s branch.</p></div></div></td><td><div><div><p><code>designcenter project publish --branch main</code></p></div></div></td></tr></tbody></table>

## designcenter project upload

\> designcenter project upload \[options\] <name> <projDir>

This Command uploads content from a Design Center project from your local directory passed in
`projDir` into an already existing Design Center project identified with `name`.

By default, this command ignores all hidden files and directories. To include hidden files and
directories, use the `--include-dot-files` option. When the `--include-dot-files` option is used,
the command uploads hidden files and folders from your specified directory.

Use the `--branch` option to select the branch you want to upload content to.

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

## designcenter project list

\> designcenter project list \[options\] \[searchText\]

This Command lists all your Design Center projects.  
You can start typing your project’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.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--pageIndex</code></p></div></div></td><td><div><div><p>Number of page to retrieve</p></div></div></td><td><div><div><p><code>designcenter project list --pageIndex 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--pageSize</code></p></div></div></td><td><div><div><p>Number of results to retrieve per page</p></div></div></td><td><div><div><p><code>designcenter project list --pageSize 5</code></p></div></div></td></tr></tbody></table>

<!-- document id=423672a61aff7b254ff2b6de925a7262dfdb75878004e85ec52942d156196a38 url=/mulesoft/current/en-us/anypoint-cli/latest/design-center.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Design Center Projects

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

Use the `designcenter` commands for managing APIs from Design Center. For more information about how
to use these commands, refer to the [Design Center documentation](https://docs.mulesoft.com/design-center/).

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#designcenter-project-create">designcenter:project:create</a></p></div></div></td><td><div><div><p>Creates a new Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-delete">designcenter:project:delete</a></p></div></div></td><td><div><div><p>Deletes a Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-download">designcenter:project:download</a></p></div></div></td><td><div><div><p>Downloads the content of a Design Center project</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-list">designcenter:project:list</a></p></div></div></td><td><div><div><p>Lists all Design Center projects</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-publish">designcenter:project:publish</a></p></div></div></td><td><div><div><p>Publishes a Design Center project to Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#designcenter-project-upload">designcenter:project:upload</a></p></div></div></td><td><div><div><p>Uploads the content of a project to Design Center</p></div></div></td></tr></tbody></table>

## designcenter:project:create

\> designcenter:project:create \[flags\] <name>

Creates a new Design Center project with the name specified in `<name>`

> [!IMPORTANT] This command does not support Mule application types.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--type (required)</code></p></div></div></td><td><div><div><p>The project type.<br>This field is required.</p></div><div><p>Supported values are:</p></div><div><ul><li><p><code>raml</code></p></li><li><p><code>raml-fragment</code></p></li><li><p><code>OAS</code></p></li></ul></div></div></td><td><div><div><p><code>--type raml</code></p></div></div></td></tr><tr><td><div><div><p><code>--fragmentType</code></p></div></div></td><td><div><div><p>The fragment type<br>Always use with <code>--type raml-fragment</code>, even for OAS 3.0 and JSON schema fragments.</p></div><div><p>This field is required if the type flag was set as <code>raml-fragment</code></p></div><div><p>Supported fragments type are:</p></div><div><ul><li><p><code>trait</code></p></li><li><p><code>resource-type</code></p></li><li><p><code>library</code></p></li><li><p><code>type</code></p></li><li><p><code>user-documentation</code></p></li><li><p><code>oas-components</code></p></li><li><p><code>json-schema</code></p></li></ul></div></div></td><td><div><div><p><code>--type raml-fragment --fragmentType user-documentation</code></p></div></div></td></tr><tr><td><div><div><p><code>--version</code></p></div></div></td><td><div><div><p>This flag is only available for OAS APIs.<br>Supported values: <code>2.0</code>, <code>3.0</code></p></div></div></td><td><div><div><p><code>--version 2.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--format</code></p></div></div></td><td><div><div><p>This flag is only available for OAS APIs.<br>Supported values: <code>YAML</code>, <code>JSON</code></p></div></div></td><td><div><div><p><code>--format YAML</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specify the response format</p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## designcenter:project:delete

\> designcenter:project:delete \[flags\] <name>

Deletes the Design Center project specified 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 the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## designcenter:project:download

\> designcenter:project:download \[flags\] <name> <targetDir>

Downloads the Design Center project passed in `name` to your local directory specified in
`targetDir`  
Use the `--resolveDependenciesTimeout=X` flag to specify the duration, in minutes, for the commands
to wait for the resolution of dependencies before downloading a project. If the specified time
passes, your project downloads without the missing dependencies.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## designcenter:project:list

\> designcenter:project:list \[flags\] \[searchText\]

Lists all your Design Center projects

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--pageIndex</code></p></div></div></td><td><div><div><p>Number of page to retrieve</p></div></div></td><td><div><div><p><code>--pageIndex 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--pageSize</code></p></div></div></td><td><div><div><p>Number of results to retrieve per page</p></div></div></td><td><div><div><p><code>--pageSize 5</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specify the response format.</p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## designcenter:project:publish

\> designcenter:project:publish \[flags\] <projectName>

Publishes the Design Center project passed in `projectName` to Exchange

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

> [!TIP] Flags that are not specified are extracted from exchange.json

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--apiVersion</code></p></div></div></td><td><div><div><p>The API version if your project is an API specification project</p></div></div></td><td><div><div><p><code>--main sample.raml --apiVersion 1.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--assetId</code></p></div></div></td><td><div><div><p>The asset assetId</p></div></div></td><td><div><div><p><code>designcenter:project:publish --assetId project</code></p></div></div></td></tr><tr><td><div><div><p><code>--groupId</code></p></div></div></td><td><div><div><p>The asset groupId</p></div></div></td><td><div><div><p><code>designcenter:project:publish --groupId com.mulesoft.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--main</code></p></div></div></td><td><div><div><p>The name of the main file name</p></div></div></td><td><div><div><p><code>--main sample.xml</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>The name for the asset</p></div></div></td><td><div><div><p><code>--name sampleProject</code></p></div></div></td></tr><tr><td><div><div><p><code>--status</code></p></div></div></td><td><div><div><p>The asset status<br>Supported values are: <code>development</code> and <code>published</code> (default)</p></div></div></td><td><div><div><p><code>designcenter:project:publish --version 1.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--tags</code></p></div></div></td><td><div><div><p>Comma separated list of tags</p></div></div></td><td><div><div><p><code>--tags test,sample,integration</code></p></div></div></td></tr><tr><td><div><div><p><code>--version</code></p></div></div></td><td><div><div><p>The asset version</p></div></div></td><td><div><div><p><code>designcenter:project:publish --version 1.0</code></p></div></div></td></tr></tbody></table>

## designcenter:project:upload

\> designcenter:project:upload \[flags\] <name> <projDir>

Uploads content from a Design Center project from your local directory passed in `projDir` into an
already existing Design Center project identified with `name`.

By default, this command ignores all hidden files and directories. To include hidden files and
directories, use the `--include-dot-files` flag. When the `--include-dot-files` flag is used, the
command uploads hidden files and folders from your specified directory.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=8ecdae4a86cb00365b2909716e11f90da9b9bc228b4361e3e2b3542e98af790d url=/mulesoft/current/en-us/anypoint-cli/latest/dx-mule.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for DX Mule Plugin

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

Use these commands to manage Mule Runtimes, scaffold Mule projects, and introspect connector
metadata from the command line.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#dx-mule-runtime-list">dx:mule:runtime:list</a></p></div></div></td><td><div><div><p>Lists all available Mule runtime versions from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#dx-mule-runtime-download">dx:mule:runtime:download</a></p></div></div></td><td><div><div><p>Downloads a Mule runtime to the local machine</p></div></div></td></tr><tr><td><div><div><p><a href="#dx-mule-runtime-path">dx:mule:runtime:path</a></p></div></div></td><td><div><div><p>Shows or sets the path to the local Mule runtime installation</p></div></div></td></tr><tr><td><div><div><p><a href="#dx-mule-project-create">dx:mule:project:create</a></p></div></div></td><td><div><div><p>Scaffolds a new Mule project with Maven structure and connector dependencies</p></div></div></td></tr><tr><td><div><div><p><a href="#dx-mule-describe-connector">dx:mule:describe-connector</a></p></div></div></td><td><div><div><p>Introspects a connector’s operations, sources, configs, and connection providers</p></div></div></td></tr></tbody></table>

## dx:mule:runtime:list

\> anypoint-cli-v4 dx:mule:runtime:list \[flags\]

Lists all available Mule runtime versions from Exchange.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command requires Anypoint credentials (username/password, client ID/secret, or bearer token).

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## dx:mule:runtime:download

\> anypoint-cli-v4 dx:mule:runtime:download \[flags\]

Downloads a Mule runtime to the local machine. If `--version` is omitted, the latest available
version is downloaded.

This command requires Anypoint credentials (username/password, client ID/secret, or bearer token).

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--version &lt;value&gt;</code></p></div></div></td><td><div><div><p>Mule runtime version to download. If omitted, downloads the latest available version.</p></div></div></td><td><div><div><p><code>--version 4.6.0</code></p></div></div></td></tr></tbody></table>

## dx:mule:runtime:path

\> anypoint-cli-v4 dx:mule:runtime:path \[flags\]

Shows the path to the local Mule runtime installation. Use `--set` to point the CLI to a specific
runtime directory.

No Anypoint credentials are required for this command.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--set &lt;value&gt;</code></p></div></div></td><td><div><div><p>Sets the path to the local Mule runtime installation</p></div></div></td><td><div><div><p><code>--set ~/mule-enterprise-standalone-4.11.2</code></p></div></div></td></tr></tbody></table>

## dx:mule:project:create

\> anypoint-cli-v4 dx:mule:project:create <PROJECTNAME> --group-id <value> \[flags\]

Scaffolds a new Mule project with a standard Maven structure and the specified connector
dependencies.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id &lt;value&gt;</code> <strong>(required)</strong></p></div></div></td><td><div><div><p>Maven group ID for the project</p></div></div></td><td><div><div><p><code>--group-id com.example</code></p></div></div></td></tr><tr><td><div><div><p><code>--dependencies &lt;value&gt;</code></p></div></div></td><td><div><div><p>Comma-separated list of connector dependencies in <code>groupId:artifactId:version</code> (GAV) format</p></div></div></td><td><div><div><p><code>--dependencies "com.mulesoft.connectors:mule-salesforce-connector:10.20.0"</code></p></div></div></td></tr><tr><td><div><div><p><code>--mule-version &lt;value&gt;</code></p></div></div></td><td><div><div><p>Mule runtime version for the project. Default: <code>4.4.0</code></p></div></div></td><td><div><div><p><code>--mule-version 4.6.0</code></p></div></div></td></tr></tbody></table>

### Example

$ anypoint-cli-v4 dx:mule:project:create my-integration \\ --group-id com.example \\ --dependencies
"com.mulesoft.connectors:mule-salesforce-connector:10.20.0" \\ --mule-version 4.6.0

## dx:mule:describe-connector

\> anypoint-cli-v4 dx:mule:describe-connector --connector <groupId:artifactId:version> \[flags\]

Introspects a connector and returns details about its operations, event sources, configurations, and
connection providers. Use `--type` to drill into a specific component.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--connector &lt;value&gt;</code> <strong>(required)</strong></p></div></div></td><td><div><div><p>Connector GAV coordinates in <code>groupId:artifactId:version</code> format</p></div></div></td><td><div><div><p><code>--connector com.mulesoft.connectors:mule-salesforce-connector:10.20.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--type &lt;value&gt;</code></p></div></div></td><td><div><div><p>Detail type to return. If omitted, returns a high-level overview (namespace, operations, sources, configs).<br>Supported values: <code>operation</code>, <code>source</code>, <code>connection-provider</code></p></div></div></td><td><div><div><p><code>--type operation</code></p></div></div></td></tr><tr><td><div><div><p><code>--name &lt;value&gt;</code></p></div></div></td><td><div><div><p>Name of the component to inspect. Required when <code>--type</code> is set.</p></div></div></td><td><div><div><p><code>--name query</code></p></div></div></td></tr><tr><td><div><div><p><code>--config-name &lt;value&gt;</code></p></div></div></td><td><div><div><p>Configuration name. Required when <code>--type</code> is <code>connection-provider</code>.</p></div></div></td><td><div><div><p><code>--config-name sfdc-config</code></p></div></div></td></tr><tr><td><div><div><p><code>--output &lt;value&gt;</code></p></div></div></td><td><div><div><p>Output format. Supported values: <code>table</code> (default), <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

### Examples

Get a high-level overview of a connector

$ anypoint-cli-v4 dx:mule:describe-connector \\ --connector
com.mulesoft.connectors:mule-salesforce-connector:10.20.0 \\ --output json

Get details for a specific operation

$ anypoint-cli-v4 dx:mule:describe-connector \\ --connector
com.mulesoft.connectors:mule-salesforce-connector:10.20.0 \\ --type operation --name query --output
json

Get details for a specific event source

$ anypoint-cli-v4 dx:mule:describe-connector \\ --connector
com.mulesoft.connectors:mule-salesforce-connector:10.20.0 \\ --type source --name on-new-object
--output json

Get details for a connection provider

$ anypoint-cli-v4 dx:mule:describe-connector \\ --connector
com.mulesoft.connectors:mule-salesforce-connector:10.20.0 \\ --type connection-provider --name
basic-connection --config-name sfdc-config --output json

<!-- document id=d35cc3a76473537057d3f23ac864b0aeb316f0447c9cadd3dbf0221ae02db964 url=/mulesoft/current/en-us/anypoint-cli/3.x/env-business-groups.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Environments and Business Groups

> 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="#use-environment">use environment</a></p></div></div></td><td><div><div><p>Make specified environment active</p></div></div></td></tr><tr><td><div><div><p><a href="#use-business-group">use business-group</a></p></div></div></td><td><div><div><p>Make specified business-group active</p></div></div></td></tr></tbody></table>

## use environment

This command is only available for interactive mode.

\> use environment \[options\] <name>

This command makes active the environment specified in `<name>`.

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

## use business-group

This command is only available for interactive mode.

\> use business-group \[options\] <name>

This command makes the business group you specified in `<name>` active.

> [!NOTE] If your business group or organization name contains spaces, you need to enclose its name
> between `"` characters.
>
> > \> use business-group "QA Organization"

<!-- document id=5b6fcc7d87eddffc574fe64493aacf07e34a184727e91dbd49141d7c2c76b2c1 url=/mulesoft/current/en-us/anypoint-cli/3.x/exchange-assets.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Exchange Assets

> 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="#exchange-asset-upload">exchange asset upload</a></p></div></div></td><td><div><div><p>Uploads an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-uploadv2">exchange asset uploadv2</a></p></div></div></td><td><div><div><p>Uploads an Exchange asset using Exchange Experience API v2</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-mutabledataupload">exchange asset mutableDataUpload</a></p></div></div></td><td><div><div><p>Modifies mutable data of an existing Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-updatestatus">exchange asset updateStatus</a></p></div></div></td><td><div><div><p>Modifies status of an existent Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-modify">exchange asset modify</a></p></div></div></td><td><div><div><p>Modifies an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-download">exchange asset download</a></p></div></div></td><td><div><div><p>Downloads an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-list">exchange asset list</a></p></div></div></td><td><div><div><p>Lists all assets</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-download">exchange asset page download</a></p></div></div></td><td><div><div><p>Downloads an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-modify">exchange asset page modify</a></p></div></div></td><td><div><div><p>Changes an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-upload">exchange asset page upload</a></p></div></div></td><td><div><div><p>Uploads an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-update">exchange asset page update</a></p></div></div></td><td><div><div><p>Updates an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-delete">exchange asset page delete</a></p></div></div></td><td><div><div><p>Deletes an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-list">exchange asset page list</a></p></div></div></td><td><div><div><p>List all pages for a given asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-copy">exchange asset copy</a></p></div></div></td><td><div><div><p>Copies an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-delete">exchange asset delete</a></p></div></div></td><td><div><div><p>Deletes an asset from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-deprecate">exchange asset deprecate</a></p></div></div></td><td><div><div><p>Deprecates an asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-undeprecate">exchange asset undeprecate</a></p></div></div></td><td><div><div><p>Undeprecate an asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-describe">exchange asset describe</a></p></div></div></td><td><div><div><p>Show a given asset’s information</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-resource-upload">exchange asset resource upload</a></p></div></div></td><td><div><div><p>Uploads a resource to an asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-resource-list">exchange asset resource list</a></p></div></div></td><td><div><div><p>Lists published resources in the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-resource-download">exchange asset resource download</a></p></div></div></td><td><div><div><p>Downloads resource from the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-resource-delete">exchange asset resource delete</a></p></div></div></td><td><div><div><p>Deletes resource from the asset portal</p></div></div></td></tr></tbody></table>

## exchange asset upload

\> exchange asset upload \[options\] <assetIdentifier> \[filePath\]

This command uploads an OAS, RAML, WSDL, HTTP, or custom asset using the IDs passed in
`<assetIdentifier>`.  
If `<filePath>` points to a ZIP archive file, that archive must include an `exchange.json` file
describing the asset.  
Argument `assetIdentifier` should be formatted as follows: `<group_id>/<asset_id>/<version>`.

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also
accepts:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--apiVersion</code></p></div></div></td><td><div><div><p>Asset API version</p></div></div></td><td rowspan="4"><div><div><p><code>exchange asset upload --apiVersion 1.0 --name testProject --classifier custom</code></p></div><div><p><code>exchange asset upload --mainFile 'api.yml'</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Asset name</p></div></div></td></tr><tr><td><div><div><p><code>--mainFile</code></p></div></div></td><td><div><div><p>Main file of the API asset</p></div></div></td></tr><tr><td><div><div><p><code>--classifier</code></p></div></div></td><td><div><div><p>Valid asset classifiers are <code>oas</code>, <code>raml</code>, <code>wsdl</code>, <code>http</code>, and <code>custom</code>.</p></div></div></td></tr></tbody></table>

## exchange asset uploadv2

\> exchange asset uploadv2 \[properties\] <assetIdentifier>

This command uploads a rest-api, soap-api, http-api, raml-fragment, custom, app, template, example,
policy, extension, external-library or connector asset using the ID passed in <assetIdentifier>.

Use the following format for the _assetIdentifier_ argument:

`([_groupID_]/)_assetID_/_version_`

If _group\_id_ is not specified, it defaults to the currently selected organization ID.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Asset name (required if no pom file is specified)</p></div></div></td><td rowspan="3"><div><div><p><code>exchange asset uploadv2 --name "Raml Asset" --description "RAML" --properties.apiVersion v1 --properties.mainFile api.raml --files.raml.zip /…​./file-path/raml.zip raml-asset/1.0.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--description</code></p></div></div></td><td><div><div><p>Asset description</p></div></div></td></tr><tr><td><div><div><p><code>--properties</code></p></div></div></td><td><div><div><p>Asset properties</p></div><div><p>For example:</p></div><div><ul><li><p><code>properties.mainFile main.yaml</code></p></li><li><p><code>properties.apiVersion v1</code></p></li><li><p><code>properties.assetLink http://api.com</code></p></li></ul></div></div></td></tr><tr><td><div><div><p><code>--files</code></p></div></div></td><td><div><div><p>Asset file, identified as <code>classifier.packaging</code> or <code>packaging</code>, for example, <code>files.raml.zip …​/file-path/raml.zip</code></p></div><div><p>To send multiple files, use the same option multiple times:</p></div><div><p><code>--files.custom.zip custom.zip --files.pom.xml pom.xml</code></p></div></div></td><td><div><div><p><code>exchange asset uploadv2 --files.mule-application.jar /…​./file-path/mule-app.jar --files.pom /…​./file-path/mule-app.pom fa7b266c-3817-4cbb-ae49-7f3cc6c8cd9e/my-mule-app/1.0.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Asset type</p></div><div><p>Required if no file is specified.</p></div><div><p>Supported Values:</p></div><div><ul><li><p><code>rest-api</code></p></li><li><p><code>soap-api</code></p></li><li><p><code>http-api</code></p></li><li><p><code>raml-fragment</code></p></li><li><p><code>custom</code></p></li><li><p><code>connector</code></p></li><li><p><code>template</code></p></li><li><p><code>example</code></p></li><li><p><code>policy</code></p></li><li><p><code>app</code></p></li><li><p><code>extension</code></p></li><li><p><code>external-library</code></p></li><li><p><code>ruleset</code></p></li></ul></div><div><p>If it is uploaded, the type is inferred from the classifier of the file.</p></div><div><p>Depending on the type of asset, some possible classifier values are:</p></div><div><ul><li><p>REST API</p><div><ul><li><p><code>oas</code> (with <code>zip</code>, <code>yaml</code>, or <code>json</code> as packaging)</p></li><li><p><code>raml</code> (with <code>zip</code> or <code>raml</code> as packaging)</p></li></ul></div></li><li><p>RAML Fragment</p><div><ul><li><p><code>raml-fragment</code> (with <code>zip</code> or <code>raml</code> as packaging)</p></li></ul></div></li><li><p>SOAP API</p><div><ul><li><p><code>wsdl</code> (with <code>zip</code>, <code>wsld</code>, or <code>xml</code> as packaging)</p></li></ul></div></li><li><p>Custom</p><div><ul><li><p><code>custom</code></p></li></ul></div></li><li><p>Application</p><div><ul><li><p><code>mule-application</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Policy</p><div><ul><li><p><code>mule-policy</code> (with <code>jar</code> as packaging) + <code>policy-definition</code> (with <code>yaml</code> as packaging)</p></li></ul></div></li><li><p>Example</p><div><ul><li><p><code>mule-application-example</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Template</p><div><ul><li><p><code>mule-application-template</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Extension</p><div><ul><li><p><code>mule-plugin</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Connector</p><div><ul><li><p><code>studio-plugin</code> (with <code>zip</code> as packaging) + file with no classifier and packaging <code>jar</code></p></li></ul></div></li><li><p>External Library</p><div><ul><li><p><code>external-library</code> (with <code>jar</code> as packaging)</p></li></ul></div></li></ul></div></div></td><td><div></div></td></tr><tr><td><div><div><p><code>--categories</code></p></div></div></td><td><div><div><p>Categories</p></div></div></td><td><div><div><p><code>categories.someKey value</code></p></div><div><p><code>categories.anotherKey anotherValue</code></p></div></div></td></tr><tr><td><div><div><p><code>--fields</code></p></div></div></td><td><div><div><p>Fields</p></div></div></td><td><div><div><p><code>fields.someKey value</code></p></div><div><p><code>fields.anotherKey anotherValue</code></p></div></div></td></tr><tr><td><div><div><p><code>--keywords</code></p></div></div></td><td><div><div><p>Keywords (comma-separated)</p></div></div></td><td><div><div><p><code>raml,rest-api,someKeyword</code></p></div></div></td></tr><tr><td><div><div><p><code>--tags</code></p></div></div></td><td><div><div><p>Tags (comma-separated)</p></div></div></td><td><div><div><p><code>api,tag1,tag2</code></p></div></div></td></tr><tr><td><div><div><p><code>--dependencies</code></p></div></div></td><td><div><div><p>Asset dependencies (comma-separated)</p></div></div></td><td><div><div><p><code>groupID:assetID:version,groupID2:assetID:version</code></p></div></div></td></tr><tr><td><div><div><p><code>--status</code></p></div></div></td><td><div><div><p>Asset status</p></div><div><p>Supported Values:</p></div><div><ul><li><p><code>development</code></p></li><li><p><code>published</code></p></li></ul></div><div><p>Default value:</p></div><div><ul><li><p><code>published</code></p></li></ul></div></div></td><td><div></div></td></tr></tbody></table>

## exchange asset mutableDataUpload

\> exchange asset mutableDataUpload \[properties\] <assetIdentifier>

This command modifies the mutable data of an already created asset, including tags, categories,
fields, and documentation.

Use the following format for the _assetIdentifier_ argument:

`[_<groupID>_]/_<assetID>_/_<version>_`

If _group\_id_ is not specified, it defaults to the currently selected organization ID.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--docs</code></p></div></div></td><td><div><div><p>Documentation file. (Should specify the "zip" file path. Example: "--docs /…​/file-path/docs.zip")</p></div></div></td><td><div><div><p><code>exchange asset mutableDataUpload --docs /Users/llucas/Desktop/examples/docs.zip --tags "tag1,tag2" --categories.beach sun --fields.central park fa7b266c-3817-4cbb-ae49-7f3cc6c8cd9e/asset-id/1.0.0</code></p></div></div></td></tr><tr><td><div><div><p><code>--categories</code></p></div></div></td><td><div><div><p>Categories</p></div></div></td><td><div><div><p><code>categories.someKey value</code></p></div><div><p><code>categories.anotherKey anotherValue</code></p></div></div></td></tr><tr><td><div><div><p><code>--fields</code></p></div></div></td><td><div><div><p>Fields</p></div></div></td><td><div><div><p><code>fields.someKey value</code></p></div><div><p><code>fields.anotherKey anotherValue</code></p></div></div></td></tr><tr><td><div><div><p><code>--tags</code></p></div></div></td><td><div><div><p>Tags (comma-separated)</p></div></div></td><td><div><div><p><code>api,tag1,tag2</code></p></div></div></td></tr></tbody></table>

## exchange asset updateStatus

\> exchange asset updateStatus \[properties\] <assetIdentifier>

This command modifies the status of an already created asset.

Use the following format for the _assetIdentifier_ argument:

`[_<groupID>_]/_<assetID>_/_<version>_`

If _group\_id_ is not specified, it defaults to the currently selected organization ID.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Command</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--status</code></p></div></div></td><td><div><div><p>Asset status</p></div><div><p>Supported Values:</p></div><div><ul><li><p><code>published</code></p></li><li><p><code>deprecated</code></p></li></ul></div></div></td><td><div><div><p><code>exchange asset updateStatus --status deprecated</code></p></div></div></td></tr></tbody></table>

Valid transitions are:

<table><colgroup><col> <col></colgroup><thead><tr><th>From</th><th>To</th></tr></thead><tbody><tr><td><div><div><p><code>development</code></p></div></div></td><td><div><div><p><code>published</code></p></div></div></td></tr><tr><td><div><div><p><code>published</code></p></div></div></td><td><div><div><p><code>deprecated</code></p></div></div></td></tr><tr><td><div><div><p><code>deprecated</code></p></div></div></td><td><div><div><p><code>published</code></p></div></div></td></tr></tbody></table>

Note that the `published` state corresponds to the `stable` state

## exchange asset modify

\> exchange asset modify \[options\] <assetIdentifier>

This command modifies the Exchange asset identified with `<assetIdentifier>`.  
Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New asset name</p></div></div></td><td rowspan="2"><div><div><p><code>exchange asset modify --name newName --tags test,sample</code></p></div></div></td></tr><tr><td><div><div><p><code>--tags</code></p></div></div></td><td><div><div><p>Comma-separated tags for the asset</p></div></div></td></tr></tbody></table>

## exchange asset download

\> exchange asset download \[options\] <assetIdentifier> <directory>

This command downloads the Exchange asset identified with `<assetIdentifier>` to the directory
passed in `<directory>`.  
Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

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

## exchange asset list

\> exchange asset list \[options\] \[searchText\]

This command lists all assets in Exchange.

> [!TIP] You can specify keywords in searchText to limit results to APIs containing those specific
> keywords.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Number of results to retrieve</p></div></div></td><td><div><div><p><code>exchange asset list --limit 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the number of APIs passed</p></div></div></td><td><div><div><p><code>exchange asset list --offset 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--organizationId</code></p></div></div></td><td><div><div><p>Filters by organization id</p></div></div></td><td><div><div><p><code>exchange asset list --organizationId a12b3c45-de6f-789g-hi01-j2klm3nop4q5</code></p></div></div></td></tr></tbody></table>

## exchange asset page download

\> exchange asset page download \[options\] <assetIdentifier> <directory> \[pageName\]

This command downloads the description page specified in `<pageName>` for the Exchange asset
identified with `<assetIdentifier>` to the directory passed in `<directory>`.  
If \[pageName\] is not specified, this command downloads all pages.

> [!NOTE] This command only supports published pages.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.  
The description page in downloaded in Markdown format. When `name` is not specified, all pages are
downloaded.

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

## exchange asset page modify

\> exchange asset page modify \[options\] <assetIdentifier> <pageName>

This command modifies the description page specified in `<pageName>`, for the Exchange asset
identified with `<assetIdentifier>`.

> [!NOTE] This command only supports published pages.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.  
Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes
the `--name` option to set a new asset page name.

## exchange asset page upload

\> exchange asset page upload \[options\] <assetIdentifier> <pageName> <mdPath>

This command uploads an asset description page from the path passed in `<mdPath>` using the name
specified in `<pageName>` to the Exchange asset identified with `<assetIdentifier>`.  
Naming the page "home" makes the uploaded page the main description page for the Exchange asset.

> [!CAUTION] This command publishes all active drafts as part of the operation.

Argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.  
This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## exchange asset page update

\> exchange asset page update \[options\] <assetIdentifier> <pageName> <mdPath>

This command updates the content of an asset description page from the path passed in `<mdPath>`
using the name specified in `<pageName>` to the Exchange asset identified with
`<assetIdentifier>`.  
Naming the page "home" makes the updated page the main description page for the Exchange asset.

> [!CAUTION] This command publishes all active drafts as part of the operation.

Argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.  
This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## exchange asset page delete

\> exchange asset page delete \[options\] <assetIdentifier> <pageName>

This command deletes the description page specified in `<pageName>`, for the asset identified with
`<assetIdentifier>`.

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

> [!NOTE] This command only supports published pages.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.  
This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## exchange asset page list

\> exchange asset page list <assetIdentifier>

This command lists all pages for the asset passed in `<assetIdentifier>`.  
Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

> [!NOTE] This command only supports published pages.

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

## exchange asset copy

\> exchange asset copy \[options\] <source> <target>

This command copies the Exchange asset from `<source>` to `<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.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--targetOrganizationId</code></p></div></div></td><td><div><div><p>Organization ID to copy asset into</p></div></div></td><td><div><div><p><code>exchange asset copy --targetOrganizationId organization_id source_group_id/source_asset_id/source_version target_group_id/target_asset_id/target_version</code></p></div></div></td></tr></tbody></table>

## exchange asset delete

\> exchange asset delete \[options\] <assetIdentifier>

This command deletes the Exchange asset passed in `<assetIdentifier>`.

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

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.  
This command accepts only the default options: `--help`, `-f`/`--fields` and `-o`/`--output`.

## exchange asset deprecate

\> exchange asset deprecate <assetIdentifier>

This command deprecates the asset passed in `<assetIdentifier>`.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

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

## exchange asset undeprecate

\> exchange asset undeprecate <assetIdentifier>

This command undeprecates the asset passed in `<assetIdentifier>`.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

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

## exchange asset describe

\> exchange asset describe <assetIdentifier>

This command describes the asset passed in `<assetIdentifier>`.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

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

## exchange asset resource upload

\> exchange asset resource upload \[options\] <assetIdentifier> <filepath>

This command uploads the resource specified in `<filepath>` to a page in the asset portal described
in `<assetIdentifier>`.

You can use this command for any page of your `<assetIdentifier>` asset.

Supported file extensions for `<filepath>` are: `jpeg`, `jpg`, `jpe`, `gif`, `bmp`, `png`, `webp`,
`ico`, `svg`, `tiff`, `tif`.

The argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

The successful output command will be a markdown codesnippet.

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

## exchange asset resource list

\> exchange asset resource list \[options\] <assetIdentifier>

This command lists the resources in the asset portal of the asset specified in `<assetIdentifier>`.

Argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

> [!NOTE] This command lists published resources by default.  
> You can use the `--draft` option to list draft resources from the asset portal.

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes
the `--draft` option to list non-published resources in the asset portal.

## exchange asset resource download

\> exchange asset resource download \[options\] <assetIdentifier> <resourcePath> <filePath>

This command downloads the published resource specified in `<resourcePath>` from the asset portal of
the asset specified in `<assetIdentifier>` to the file specified in `<filePath>`.

Argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

Argument `<resourcePath>` must be a published resource.  
You can list all published resources using the [asset resource list](#exchange-asset-resource-list)
command.

> [!NOTE] This command only supports published resources.

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

## exchange asset resource delete

\> exchange asset resource delete \[options\] <assetIdentifier> <resourcePath>

This command deletes the resource specified in `<resourcePath>` from the asset portal of the asset
specified in `<assetIdentifier>` by publishing a new portal in which `resourcePath` has been
deleted.

Argument `<assetIdentifier>` should be formatted as follows: `[group_id]/<asset_id>/<version>`.  
If `group_id` is not specified, it defaults to the currently selected Organization ID.

Argument `<resourcePath>` must be a published resource.  
You can list all published resources using the [asset resource list](#exchange-asset-resource-list)
command.

> [!CAUTION] This command publishes all active drafts as part of the operation.

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

<!-- document id=bfc403fdefb1c021ce4aa423c5bc0909e5b2b792b057d956609f99b70bac22fa url=/mulesoft/current/en-us/anypoint-cli/latest/exchange-assets.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Exchange Assets

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

Use the `exchange` commands to automate your Exchange processes. For more information about how to
use these commands, refer to the [Exchange documentation](https://docs.mulesoft.com/exchange/).

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#exchange-asset-copy">exchange:asset:copy</a></p></div></div></td><td><div><div><p>Copies an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-delete">exchange:asset:delete</a></p></div></div></td><td><div><div><p>Deletes an asset from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-deprecate">exchange:asset:deprecate</a></p></div></div></td><td><div><div><p>Deprecates an asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-describe">exchange:asset:describe</a></p></div></div></td><td><div><div><p>Shows a given asset’s information</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-download">exchange:asset:download</a></p></div></div></td><td><div><div><p>Downloads an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-list">exchange:asset:list</a></p></div></div></td><td><div><div><p>Lists all assets</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-modify">exchange:asset:modify</a></p></div></div></td><td><div><div><p>Modifies an Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-mutableDataUpload">exchange:asset:mutableDataUpload</a></p></div></div></td><td><div><div><p>Modifies mutable data of an existing Exchange asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-delete">exchange:asset:page:delete</a></p></div></div></td><td><div><div><p>Deletes an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-download">exchange:asset:page:download</a></p></div></div></td><td><div><div><p>Downloads an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-list">exchange:asset:page:list</a></p></div></div></td><td><div><div><p>List all pages for a given asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-modify">exchange:asset:page:modify</a></p></div></div></td><td><div><div><p>Changes an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-update">exchange:asset:page:update</a></p></div></div></td><td><div><div><p>Updates an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-page-upload">exchange:asset:page:upload</a></p></div></div></td><td><div><div><p>Uploads an asset’s description page from Exchange</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-resource-delete">exchange:asset:resource:delete</a></p></div></div></td><td><div><div><p>Deletes resource from the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-resource-download">exchange:asset:resource:download</a></p></div></div></td><td><div><div><p>Downloads resource from the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-resource-list">exchange:asset:resource:list</a></p></div></div></td><td><div><div><p>Lists published resources in the asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-resource-upload">exchange:asset:resource:upload</a></p></div></div></td><td><div><div><p>Uploads a resource to an asset portal</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-undeprecate">exchange:asset:undeprecate</a></p></div></div></td><td><div><div><p>Undeprecates an asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-updateStatus">exchange:asset:updateStatus</a></p></div></div></td><td><div><div><p>Modifies the status of an existing asset</p></div></div></td></tr><tr><td><div><div><p><a href="#exchange-asset-upload">exchange:asset:upload</a></p></div></div></td><td><div><div><p>Uploads an Exchange asset using Exchange Experience API</p></div></div></td></tr></tbody></table>

> [!NOTE] Exchange commands are currently not available for GovCloud.

## exchange:asset:copy

\> exchange:asset:copy \[flags\] <source> <target>

Copies the Exchange asset from `<source>` to `<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

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--targetOrganizationId</code></p></div></div></td><td><div><div><p>Organization ID to copy asset into</p></div></div></td><td><div><div><p><code>--targetOrganizationId organization_id source_group_id/source_asset_id/source_version target_group_id/target_asset_id/target_version</code></p></div></div></td></tr></tbody></table>

## exchange:asset:delete

\> exchange:asset:delete \[flags\] <assetIdentifier>

Deletes the Exchange asset passed in `<assetIdentifier>`

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

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the default flag `--help`.

## exchange:asset:deprecate

\> exchange:asset:deprecate <assetIdentifier>

Deprecates the asset passed in `<assetIdentifier>`

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:describe

\> exchange:asset:describe <assetIdentifier>

Describes the asset passed in `<assetIdentifier>`

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

> [!NOTE] When using `--output json`, the `versions` property in the response includes information
> about all available versions of the asset, not only the version specified in `<assetIdentifier>`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:download

\> exchange:asset:download \[flags\] <assetIdentifier> <directory>

Downloads the Exchange asset identified with `<assetIdentifier>` to the directory passed in
`<directory>`  
Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:list

\> exchange:asset:list \[flags\] \[searchText\]

Lists all assets in Exchange

> [!TIP] You can specify keywords in searchText to limit results to APIs containing those specific
> keywords.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Number of results to retrieve</p></div></div></td><td><div><div><p><code>--limit 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the number of APIs passed</p></div></div></td><td><div><div><p><code>--offset 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--organizationId</code></p></div></div></td><td><div><div><p>Filters by organization id</p></div></div></td><td><div><div><p><code>--organizationId a12b3c45-de6f-789g-hi01-j2klm3nop4q5</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format.</p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## exchange:asset:modify

\> exchange:asset:modify \[flags\] <assetIdentifier>

Modifies the Exchange asset identified with `<assetIdentifier>`  
Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New asset name</p></div></div></td><td><div><div><p><code>--name newName</code></p></div></div></td></tr><tr><td><div><div><p><code>--tags</code></p></div></div></td><td><div><div><p>Comma-separated tags for the asset</p></div></div></td><td><div><div><p><code>--tags tag1,tag2</code></p></div></div></td></tr></tbody></table>

## exchange:asset:mutableDataUpload

\> exchange:asset:mutableDataUpload \[flags\] <assetIdentifier>

Modifies the mutable data of an already created asset, including tags, categories, fields, and
documentation

Argument `assetIdentifier` should be formatted as follows: `[_<groupID>_]/_<assetID>_/_<version>_`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--docs</code></p></div></div></td><td><div><div><p>Documentation file (Should specify the "zip" file path)</p></div></div></td><td><div><div><p><code>--docs /Users/llucas/Desktop/examples/docs.zip</code></p></div></div></td></tr><tr><td><div><div><p><code>--categories</code></p></div></div></td><td><div><div><p>Categories</p></div></div></td><td><div><div><p><code>--categories='{"someKey":"value", "anotherKey":"anotherValue"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--fields</code></p></div></div></td><td><div><div><p>Fields</p></div></div></td><td><div><div><p><code>--fields='{"someKey":"value", "anotherKey":"anotherValue"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--tags</code></p></div></div></td><td><div><div><p>Tags (comma-separated)</p></div></div></td><td><div><div><p><code>--tags api,tag1,tag2</code></p></div></div></td></tr></tbody></table>

## exchange:asset:page:delete

\> exchange:asset:page:delete \[flags\] <assetIdentifier> <pageName>

Deletes the description page specified in `<pageName>`, for the asset identified with
`<assetIdentifier>`

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

> [!NOTE] This command only supports published pages.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:page:download

\> exchange:asset:page:download \[flags\] <assetIdentifier> <directory> \[pageName\]

Downloads the description page specified in `<pageName>` for the Exchange asset identified with
`<assetIdentifier>` to the directory passed in `<directory>`  
If \[pageName\] is not specified, this command downloads all pages.

> [!NOTE] This command only supports published pages.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID  
The description page is downloaded in Markdown format.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:page:list

\> exchange:asset:page:list <assetIdentifier>

Lists all pages for the asset passed in `<assetIdentifier>`  
Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

> [!NOTE] This command only supports published pages.

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:page:modify

\> exchange:asset:page:modify \[flags\] <assetIdentifier> <pageName>

Modifies the description page specified in `<pageName>`, for the Exchange asset identified with
`<assetIdentifier>`

> [!NOTE] This command only supports published pages.

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the `--name` flag to set a new asset page name.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:page:update

\> exchange:asset:page:update \[flags\] <assetIdentifier> <pageName> <mdPath>

Updates the content of an asset description page from the path passed in `<mdPath>` using the name
specified in `<pageName>` to the Exchange asset identified with `<assetIdentifier>`  
Naming the page "home" makes the updated page the main description page for the Exchange asset.

> [!CAUTION] This command publishes all active drafts as part of the operation.

Argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:page:upload

\> exchange:asset:page:upload \[flags\] <assetIdentifier> <pageName> <mdPath>

Uploads an asset description page from the path passed in `<mdPath>` using the name specified in
`<pageName>` to the Exchange asset identified with `<assetIdentifier>`  
Naming the page "home" makes the uploaded page the main description page for the Exchange asset.

> [!CAUTION] This command publishes all active drafts as part of the operation.

Argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:resource:delete

\> exchange:asset:resource:delete \[flags\] <assetIdentifier> <resourcePath>

Deletes the resource specified in `<resourcePath>` from the asset portal of the asset specified in
`<assetIdentifier>` by publishing a new portal in which `resourcePath` has been deleted.

Argument `<assetIdentifier>` should be formatted as follows: `[group_id]/<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

Argument `<resourcePath>` must be a published resource  
You can list all published resources using the [asset resource list](#exchange-asset-resource-list)
command.

> [!CAUTION] This command publishes all active drafts as part of the operation.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:resource:download

\> exchange:asset:resource:download \[flags\] <assetIdentifier> <resourcePath> <filePath>

Downloads the published resource specified in `<resourcePath>` from the asset portal of the asset
specified in `<assetIdentifier>` to the file specified in `<filePath>`

Argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

Argument `<resourcePath>` must be a published resource  
You can list all published resources using the [asset resource list](#exchange-asset-resource-list)
command.

> [!NOTE] This command only supports published resources.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:resource:list

\> exchange:asset:resource:list \[flags\] <assetIdentifier>

Lists the resources in the asset portal of the asset specified in `<assetIdentifier>`

Argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

> [!NOTE] This command lists published resources by default.

This command accepts the `--draft` flag to list non-published resources in the asset portal.

Prompt the `--output` flag to specify the response format. Supported values are `table` (default)
and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:resource:upload

\> exchange:asset:resource:upload \[flags\] <assetIdentifier> <filepath>

Uploads the resource specified in `<filepath>` to a page in the asset portal described in
`<assetIdentifier>`

You can use this command for any page of your `<assetIdentifier>` asset  
Supported file extensions for `<filepath>` are: `jpeg`, `jpg`, `jpe`, `gif`, `bmp`, `png`, `webp`,
`ico`, `svg`, `tiff`, `tif`

The argument `assetIdentifier` should be formatted as follows: `[group_id]/<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

The successful output command will be a markdown codesnippet.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:undeprecate

\> exchange:asset:undeprecate <assetIdentifier>

Undeprecates the asset passed in `<assetIdentifier>`

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## exchange:asset:updateStatus

\> exchange:asset:updateStatus \[flags\] <assetIdentifier>

Modifies the status of an already created asset

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--status</code></p></div></div></td><td><div><div><p>Asset status</p></div><div><p>Supported Values:</p></div><div><ul><li><p><code>published</code></p></li><li><p><code>deprecated</code></p></li></ul></div></div></td><td><div><div><p><code>--status deprecated</code></p></div></div></td></tr></tbody></table>

Valid transitions are:

<table><colgroup><col> <col></colgroup><thead><tr><th>From</th><th>To</th></tr></thead><tbody><tr><td><div><div><p><code>development</code></p></div></div></td><td><div><div><p><code>published</code></p></div></div></td></tr><tr><td><div><div><p><code>published</code></p></div></div></td><td><div><div><p><code>deprecated</code></p></div></div></td></tr><tr><td><div><div><p><code>deprecated</code></p></div></div></td><td><div><div><p><code>published</code></p></div></div></td></tr></tbody></table>

> [!NOTE] the `published` state corresponds to the `stable` state

## exchange:asset:upload

\> exchange:asset:upload \[flags\] <assetIdentifier>

Uploads a rest-api, soap-api, http-api, raml-fragment, custom, app, template, example, policy,
extension, external-library, connector asset, or ruleset using the ID passed in `<assetIdentifier>`

Argument `assetIdentifier` should be formatted as follows: `([group_id]/)<asset_id>/<version>`  
If `group_id` is not specified, it defaults to the currently selected Organization ID

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--categories</code></p></div></div></td><td><div><div><p>Categories (value should be a string in JSON format)</p></div></div></td><td><div><div><p><code>--categories '{"Department": "IT"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--dependencies</code></p></div></div></td><td><div><div><p>Asset dependencies (comma-separated)</p></div></div></td><td><div><div><p><code>--dependencies groupID:assetID:version,groupID2:assetID:version</code></p></div></div></td></tr><tr><td><div><div><p><code>--description</code></p></div></div></td><td><div><div><p>Asset description</p></div></div></td><td><div><div><p><code>--description "RAML"</code></p></div></div></td></tr><tr><td><div><div><p><code>--files</code></p></div></div></td><td><div><div><p>Asset file, identified as <code>classifier.packaging</code> or <code>packaging</code> and its file path<br>To send multiple files, you can use the same flag multiple times.<br>An exception to this is when you upload ruleset documentation with a ruleset. Both sets of classifiers and packaging options must be entered in a single <code>--files</code> flag</p></div></div></td><td><div><div><p>To upload a POM file and a RAML specification:</p></div><div><p><code>--files'{"pom.xml": "directory/pom-file.xml"}' --files='{"raml.raml": "./my-api.raml"}'</code></p></div><div><p>To upload a ruleset and its documentation:</p></div><div><p><code>anypoint-cli-v4 exchange asset upload my-auth-best-practices/1.0.0 --name "My Best Practices Ruleset" --description "This ruleset enforces my best practices for APIs." --files='{"ruleset.yaml":"/myRulesetFolder/mynewruleset.yaml","docs.zip":"/myRulesetFolder/ruleset.doc.zip"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--fields</code></p></div></div></td><td><div><div><p>Fields (value should be a string in JSON format)</p></div></div></td><td><div><div><p><code>--fields '{"releaseDate": "2020-01-01T20:00:00.000Z"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--keywords</code></p></div></div></td><td><div><div><p>Keywords (comma-separated)</p></div></div></td><td><div><div><p><code>--keywords raml,rest-api,someKeyword</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Asset name (required if no pom file is specified)</p></div></div></td><td><div><div><p><code>--name "Raml Asset"</code></p></div></div></td></tr><tr><td><div><div><p><code>--properties</code></p></div></div></td><td><div><div><p>Asset properties<br>The file of the specified "mainFile" property must be in the uploaded zip file on the root path. The file cannot be in a subfolder.</p></div></div></td><td><div><div><p><code>--properties='{"apiVersion":"v1", "mainFile":"api.raml", "contactName":"contact", "contactEmail":"<a href="mailto:example@mulesoft.com">example@mulesoft.com</a>"}'</code></p></div></div></td></tr><tr><td><div><div><p><code>--status</code></p></div></div></td><td><div><div><p>Asset status<br>Supported Values:</p></div><div><ul><li><p><code>development</code></p></li><li><p><code>published</code> (default)</p></li></ul></div></div></td><td><div><div><p><code>--status development</code></p></div></div></td></tr><tr><td><div><div><p><code>--tags</code></p></div></div></td><td><div><div><p>Tags (comma-separated)</p></div></div></td><td><div><div><p><code>-- tags api,tag1,tag2</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Asset type</p></div><div><p>Required if no file is specified.</p></div><div><p>Supported Values:</p></div><div><ul><li><p><code>rest-api</code></p></li><li><p><code>soap-api</code></p></li><li><p><code>http-api</code></p></li><li><p><code>raml-fragment</code></p></li><li><p><code>custom</code></p></li><li><p><code>connector</code></p></li><li><p><code>template</code></p></li><li><p><code>example</code></p></li><li><p><code>policy</code></p></li><li><p><code>app</code></p></li><li><p><code>extension</code></p></li><li><p><code>external-library</code></p></li><li><p><code>ruleset</code></p></li></ul></div><div><p>If it is uploaded, the type is inferred from the classifier of the file</p></div><div><p>Depending on the type of asset, some possible classifier values are:</p></div><div><ul><li><p>REST API</p><div><ul><li><p><code>oas</code> (with <code>zip</code>, <code>yaml</code>, or <code>json</code> as packaging)</p></li><li><p><code>raml</code> (with <code>zip</code> or <code>raml</code> as packaging)</p></li></ul></div></li><li><p>RAML Fragment</p><div><ul><li><p><code>raml-fragment</code> (with <code>zip</code> or <code>raml</code> as packaging)</p></li></ul></div></li><li><p>SOAP API</p><div><ul><li><p><code>wsdl</code> (with <code>zip</code>, <code>wsld</code>, or <code>xml</code> as packaging)</p></li></ul></div></li><li><p>Custom</p><div><ul><li><p><code>custom</code></p></li><li><p><code>docs</code> (with <code>doc.zip</code> as packaging)</p></li></ul></div></li><li><p>Application</p><div><ul><li><p><code>mule-application</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Policy</p><div><ul><li><p><code>mule-policy</code> (with <code>jar</code> as packaging) + <code>policy-definition</code> (with <code>yaml</code> as packaging)</p></li></ul></div></li><li><p>Example</p><div><ul><li><p><code>mule-application-example</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Template</p><div><ul><li><p><code>mule-application-template</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Extension</p><div><ul><li><p><code>mule-plugin</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Connector</p><div><ul><li><p><code>studio-plugin</code> (with <code>zip</code> as packaging) + file with no classifier and packaging <code>jar</code></p></li></ul></div></li><li><p>External Library</p><div><ul><li><p><code>external-library</code> (with <code>jar</code> as packaging)</p></li></ul></div></li><li><p>Ruleset</p><div><ul><li><p><code>ruleset</code> (with <code>zip</code> or <code>yaml</code> as packaging)</p></li></ul></div></li></ul></div></div></td><td><div><div><p><code>--type rest-api</code></p></div></div></td></tr></tbody></table>

## See Also

- [Autocataloging APIs Using API Catalog CLI](https://docs.mulesoft.com/exchange/apicat-about-api-catalog-cli)

<!-- document id=3e7a93556fafeefc4daba5e1beef9921a4e4ccf4b5ad085c98c102a557dfd59d url=/mulesoft/current/en-us/anypoint-cli/3.x/standalone-alerts.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Hybrid Application Alerts

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

Use these commands to control alerts for apps that are deployed to your local Mule server and
managed with Runtime Manager.

<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-standalone-alert-describe">runtime-mgr standalone-alert describe</a></p></div></div></td><td><div><div><p>Describes an alert</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-alert-create">runtime-mgr standalone-alert create</a></p></div></div></td><td><div><div><p>Creates new alert for standalone runtime</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-alert-modify">runtime-mgr standalone-alert modify</a></p></div></div></td><td><div><div><p>Modifies alert for standalone runtime</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-alert-list">runtime-mgr standalone-alert list</a></p></div></div></td><td><div><div><p>Lists all alerts for standalone runtimes in the environment</p></div></div></td></tr></tbody></table>

## runtime-mgr standalone-alert describe

\> runtime-mgr standalone-alert describe \[options\] <alertId>

This command describes the alert passed in `alertId`.

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

## runtime-mgr standalone-alert create

\> runtime-mgr standalone-alert create \[options\] <name>

This command creates a new alert for a standalone runtime with the ID passed in `name`. The alert
`name` is limited to 256 characters.

Besides 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><p><code>--severity &lt;val&gt;</code></p></td><td><p>Alert severity</p></td></tr><tr><td><p><code>--resourceType &lt;type&gt;</code></p></td><td><p>Alert resource type</p></td></tr><tr><td><p><code>--resource [id]</code></p></td><td><p>Alert resource ID. Can be used multiple types. If not provided alert triggers for all resources. Depending on <code>resourceType</code> resource can be application, server, server-group or cluster.</p></td></tr><tr><td><p><code>--condition &lt;val&gt;</code></p></td><td><p>Alert trigger condition</p></td></tr><tr><td><p><code>--period [minutes]</code></p></td><td><p>Condition duration in minutes</p></td></tr><tr><td><p><code>--threshold [num]</code></p></td><td><p>Condition threshold number</p></td></tr><tr><td><p><code>--operator [type]</code></p></td><td><p>Condition operator explaining values relation to threshold.</p></td></tr><tr><td><p><code>--subject &lt;string&gt;</code></p></td><td><p>Alert notification email subject</p></td></tr><tr><td><p><code>--content &lt;string&gt;</code></p></td><td><p>Alert notification email body</p></td></tr><tr><td><p><code>--recipient [username]</code></p></td><td><p>Username to send alert notification to. Can be used multiple times to specify up to 20 platform user IDs.</p></td></tr><tr><td><p><code>--email [emailAddress]</code></p></td><td><p>Email address to send alert notification to. Can be used multiple times to specify up to 20 email addresses.</p></td></tr></tbody></table>

## runtime-mgr standalone-alert modify

\> runtime-mgr standalone-alert modify \[options\] <alertId>

This command modifies the alert passed in `alertId`.

Besides 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><p><code>--name &lt;value&gt;</code></p></td><td><p>Alert name</p></td></tr><tr><td><p><code>--severity &lt;value&gt;</code></p></td><td><p>Alert severity</p></td></tr><tr><td><p><code>--resourceType &lt;type&gt;</code></p></td><td><p>Alert resource type</p></td></tr><tr><td><p><code>--resource [id]</code></p></td><td><p>Alert resource ID. Can be used multiple types. If not provided alert triggers for all resources. Depending on <code>resourceType</code> resource can be application, server, server-group or cluster.</p></td></tr><tr><td><p><code>--condition &lt;value&gt;</code></p></td><td><p>Alert trigger condition</p></td></tr><tr><td><p><code>--period [minutes]</code></p></td><td><p>Condition duration in minutes</p></td></tr><tr><td><p><code>--threshold [num]</code></p></td><td><p>Condition threshold number</p></td></tr><tr><td><p><code>--operator [type]</code></p></td><td><p>Condition operator explaining values relation to threshold.</p></td></tr><tr><td><p><code>--subject &lt;string&gt;</code></p></td><td><p>Alert notification email subject</p></td></tr><tr><td><p><code>--content &lt;string&gt;</code></p></td><td><p>Alert notification email body</p></td></tr><tr><td><p><code>--recipient [username]</code></p></td><td><p>Username to send alert notification to. Can be used multiple times to specify up to 20 platform user IDs.</p></td></tr><tr><td><p><code>--email [emailAddress]</code></p></td><td><p>Email address to send alert notification to. Can be used multiple times to specify up to 20 email addresses.</p></td></tr></tbody></table>

## runtime-mgr standalone-alert list

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

This command lists all alerts for standalone Mules in the current environment.

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

<!-- document id=57c8eb80967a75207d8fd2494c4c279e8650f12d7b622cde55310cba468cf4cb url=/mulesoft/current/en-us/anypoint-cli/latest/standalone-alerts.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Hybrid Application Alerts

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

Use these commands to control alerts for apps that are deployed to your local Mule server and
managed with Runtime Manager. For more information about how to use these commands, refer to the
[Runtime Manager documentation](https://docs.mulesoft.com/runtime-manager/).

<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-standalone-alert-create">runtime-mgr:standalone-alert:create</a></p></div></div></td><td><div><div><p>Creates new alert for standalone runtime</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-alert-describe">runtime-mgr:standalone-alert:describe</a></p></div></div></td><td><div><div><p>Describes an alert</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-alert-list">runtime-mgr:standalone-alert:list</a></p></div></div></td><td><div><div><p>Lists all alerts for standalone runtimes in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-alert-modify">runtime-mgr:standalone-alert:modify</a></p></div></div></td><td><div><div><p>Modifies alert for standalone runtime</p></div></div></td></tr></tbody></table>

## runtime-mgr:standalone-alert:create

\> runtime-mgr:standalone-alert:create <name> \[flags\]

Creates a new alert for a standalone runtime with the ID passed in `name`. The alert `name` is
limited to 256 characters.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><p><code>--condition</code></p></td><td><p>Alert trigger condition</p></td><td><p><code>--condition cluster-up</code></p></td></tr><tr><td><p><code>--content &lt;string&gt;</code></p></td><td><p>Alert notification email body</p></td><td><p><code>--content Email Body</code></p></td></tr><tr><td><p><code>--email</code></p></td><td><p>Email address to send alert notification to<br>Can be used multiple times to specify up to 20 email addresses</p></td><td><p><code>--email <a href="mailto:user@mulesoft.com">user@mulesoft.com</a></code></p></td></tr><tr><td><p><code>--operator</code></p></td><td><p>Condition operator explaining values relation to threshold.</p></td><td><p><code>--operator gt</code></p></td></tr><tr><td><p><code>--period</code></p></td><td><p>Condition duration in minutes</p></td><td><p><code>--period 15</code></p></td></tr><tr><td><p><code>--recipient</code></p></td><td><p>Username to send alert notification to<br>Can be used multiple times to specify up to 20 platform user IDs</p></td><td><p><code>--recipient 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></td></tr><tr><td><p><code>--resource</code></p></td><td><p>Alert resource ID. If not provided alert triggers for all resources. Depending on <code>resourceType</code>, the resource id can be of an application, server, server-group or cluster.</p></td><td><p><code>--resource 12343</code></p></td></tr><tr><td><p><code>--resourceType</code></p></td><td><p>Alert resource type</p></td><td><p><code>--resourceType server</code></p></td></tr><tr><td><p><code>--severity</code></p></td><td><p>Alert severity</p></td><td><p><code>--severity 3</code></p></td></tr><tr><td><p><code>--subject &lt;string&gt;</code></p></td><td><p>Alert notification email subject</p></td><td><p><code>--subject Email Subject</code></p></td></tr><tr><td><p><code>--threshold</code></p></td><td><p>Condition threshold number</p></td><td><p><code>--threshold 10</code></p></td></tr></tbody></table>

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

## runtime-mgr:standalone-alert:describe

\> runtime-mgr:standalone-alert:describe \[flags\] <alertId>

Describes the alert passed in `alertId`.

This command accepts the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:standalone-alert:list

\> runtime-mgr:standalone-alert:list \[flags\]

Lists all alerts for standalone Mules in the current environment.

This command accepts the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:standalone-alert:modify

\> runtime-mgr:standalone-alert:modify <alertId> \[flags\]

Modifies the alert passed in `alertId`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><p><code>--condition</code></p></td><td><p>Alert trigger condition</p></td><td><p><code>--condition server-load-average</code></p></td></tr><tr><td><p><code>--content &lt;string&gt;</code></p></td><td><p>Alert notification email body</p></td><td><p><code>--content Email Body</code></p></td></tr><tr><td><p><code>--email</code></p></td><td><p>Email address to send alert notification to<br>Can be used multiple times to specify up to 20 email addresses</p></td><td><p><code>--email <a href="mailto:user@mulesoft.com">user@mulesoft.com</a></code></p></td></tr><tr><td><p><code>--name</code></p></td><td><p>Alert name</p></td><td><p><code>--name testAlert</code></p></td></tr><tr><td><p><code>--operator</code></p></td><td><p>Condition operator explaining values relation to threshold.</p></td><td><p><code>--operator lt-</code></p></td></tr><tr><td><p><code>--period</code></p></td><td><p>Condition duration in minutes</p></td><td><p><code>--period 15</code></p></td></tr><tr><td><p><code>--recipient</code></p></td><td><p>Username to send alert notification to<br>Can be used multiple times to specify up to 20 platform user IDs</p></td><td><p><code>--recipient 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></td></tr><tr><td><p><code>--resource</code></p></td><td><p>Alert resource ID. If not provided alert triggers for all resources. Depending on <code>resourceType</code>, the resource id can be of an application, server, server-group or cluster.</p></td><td><p><code>--resource 12343</code></p></td></tr><tr><td><p><code>--resourceType</code></p></td><td><p>Alert resource type</p></td><td><p><code>--resourceType server</code></p></td></tr><tr><td><p><code>--severity</code></p></td><td><p>Alert severity</p></td><td><p><code>--severity 3</code></p></td></tr><tr><td><p><code>--subject &lt;string&gt;</code></p></td><td><p>Alert notification email subject</p></td><td><p><code>--subject Email Subject</code></p></td></tr><tr><td><p><code>--threshold</code></p></td><td><p>Condition threshold number</p></td><td><p><code>--threshold 10</code></p></td></tr></tbody></table>

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

<!-- document id=6e79a6d043c1dc44c48e393d06b0d37f05eb9e140b1526ff59e6aaa4e625ef9f url=/mulesoft/current/en-us/anypoint-cli/3.x/standalone-apps.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Hybrid Applications

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

Use these commands for apps that are deployed to your local Mule server and managed with Runtime
Manager.

For the Anypoint Platform CLI to recognize your target servers, each server must be manually
registered with the platform.

<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-standalone-application-artifact">runtime-mgr standalone-application artifact</a></p></div></div></td><td><div><div><p>Downloads a standalone application artifact binary</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-deploy">runtime-mgr standalone-application deploy</a></p></div></div></td><td><div><div><p>Deploys or redeploys an application to an on-premises server, server group, or cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-describe-json">runtime-mgr standalone-application describe-json</a></p></div></div></td><td><div><div><p>Shows a raw standalone application JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-modify">runtime-mgr standalone-application modify</a></p></div></div></td><td><div><div><p>Changes a standalone application artifact</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-start">runtime-mgr standalone-application start</a></p></div></div></td><td><div><div><p>Starts a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-delete">runtime-mgr standalone-application delete</a></p></div></div></td><td><div><div><p>Deletes a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-describe">runtime-mgr standalone-application describe</a></p></div></div></td><td><div><div><p>Shows detailed information for a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-list">runtime-mgr standalone-application list</a></p></div></div></td><td><div><div><p>Lists all standalone applications in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-restart">runtime-mgr standalone-application restart</a></p></div></div></td><td><div><div><p>Restarts a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-stop">runtime-mgr standalone-application stop</a></p></div></div></td><td><div><div><p>Stops a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-copy">runtime-mgr standalone-application copy</a></p></div></div></td><td><div><div><p>Copies a standalone application</p></div></div></td></tr></tbody></table>

## runtime-mgr standalone-application artifact

\> runtime-mgr standalone-application artifact \[options\] <identifier> <directory>

This command downloads the application artifact of the `identifier` application, to the directory
passed in `directory`. The `identifier` parameter can be either an application ID or name.

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

## runtime-mgr standalone-application deploy

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

This command deploys or redeploys the application passed as a ZIP file in the path `zipfile` to the
on-premises target passed in `targetIdentifier`.

The `targetIdentifier` parameter can be either a target ID or name.

A target can be either a server, server group, or cluster.

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

To redeploy an app and set a logging level or turn on Insight event tracking, see
[runtime-mgr standalone-application modify](#runtime-mgr-standalone-application-modify).

## runtime-mgr standalone-application describe-json

\> runtime-mgr standalone-application describe-json \[options\] <identifier>

This command describes the standalone (on-premises) application passed in `identifier` as a raw JSON
response.

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

## runtime-mgr standalone-application modify

\> runtime-mgr standalone-application modify \[options\] <identifier> <zipfile>

This command modifies the standalone (on-premises) application passed in `identifier` with the ZIP
file application passed in `zipfile` as a path.

The `identifier` parameter specifies the application identifier. To retrieve the identifier, see
[runtime-mgr standalone-application list](https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps#runtime-mgr-standalone-application-list).

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><p><code>--insight</code></p></td><td><div><div><p>Stores message metadata of every Mule transaction.</p></div></div></td></tr><tr><td><p><code>--log [level:scope]</code></p></td><td><div><div><p>Sets the logging level and scope pair:</p></div><div><ul><li><p><code>level</code>: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF</p></li><li><p><code>scope</code>: package name of the class, connector, or module to log, such as <code>org.mule.extension.ftp</code> for Anypoint Connector for FTP</p></li></ul></div><div><p>To set multiple logging levels, provide multiple <code>--log</code> options, for example, <code>--log INFO:org.apache --log WARN:org.mule</code>.</p></div></div></td></tr></tbody></table>

## runtime-mgr standalone-application start

\> runtime-mgr standalone-application start \[options\] <identifier>

This command starts the standalone (on-premises) application passed in `identifier`.

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

## runtime-mgr standalone-application delete

\> runtime-mgr standalone-application delete \[options\] <identifier>

This command deletes the standalone (on-premises) application passed in `identifier`.

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

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

## runtime-mgr standalone-application describe

\> runtime-mgr standalone-application describe \[options\] <identifier>

This command shows detailed information, such as status, creation date, and last update, for the
standalone (on-premises) application passed in `identifier`.

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

## runtime-mgr standalone-application list

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

This command lists all standalone (on-premises) applications.

Besides 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><code>--limit &lt;num&gt;</code></p></div></div></td><td><div><div><p>Specifies the number of results to retrieve</p></div></div></td></tr><tr><td><div><div><p><code>--offset &lt;num&gt;</code></p></div></div></td><td><div><div><p>Offsets the number of applications passed</p></div></div></td></tr></tbody></table>

## runtime-mgr standalone-application restart

\> runtime-mgr standalone-application restart \[options\] <identifier>

This command restarts the standalone (on-premises) application passed in `identifier`.

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

## runtime-mgr standalone-application stop

\> runtime-mgr standalone-application stop \[options\] <identifier>

This command stops the standalone (on-premises) application passed in `identifier`.

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

## runtime-mgr standalone-application copy

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

This command copies the standalone (on-premises) application passed in `source` to the target passed
in `target` and the server, server group or cluster ID or Name passed in `targetIdentifier`.

Both arguments `source` and `destination` are represented using the format:
`<organizationName>:<environmentName>/<appName>`, for example:

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

Copies the application named `application-1` from the QA environment of the _Services_ organization
to the QA environment of the `_Development_` organization in the server ID 123456.

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 standalone-application copy application-1 Development/QA/application-2 123456

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

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

<!-- document id=b3396b80d499a2c0ac01a154be4850588013d7b4fe2c461885bf784e6a6e9c9e url=/mulesoft/current/en-us/anypoint-cli/3.x/server-clusters.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Local Cluster Servers

> 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-cluster-add-server">runtime-mgr cluster add server</a></p></div></div></td><td><div><div><p>Adds server to cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-delete">runtime-mgr cluster delete</a></p></div></div></td><td><div><div><p>Deletes cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-list">runtime-mgr cluster list</a></p></div></div></td><td><div><div><p>Lists all clusters in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-remove-server">runtime-mgr cluster remove server</a></p></div></div></td><td><div><div><p>Removes server from a cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-create">runtime-mgr cluster create</a></p></div></div></td><td><div><div><p>Creates new cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-describe">runtime-mgr cluster describe</a></p></div></div></td><td><div><div><p>Describes server cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-modify">runtime-mgr cluster modify</a></p></div></div></td><td><div><div><p>Modifies cluster</p></div></div></td></tr></tbody></table>

## runtime-mgr cluster add server

\> runtime-mgr cluster add server \[options\] <clusterId> <serverId>

This command adds the cluster in `clusterId` to the server passed in `serverId`.

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

## runtime-mgr cluster delete

\> runtime-mgr cluster delete \[options\] <clusterId>

This command deletes the cluster passed in `clusterId`.

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

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

## runtime-mgr cluster list

\> runtime-mgr cluster list \[options\]

This command lists all clusters in the environment.

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

## runtime-mgr cluster remove server

\> runtime-mgr cluster remove server \[options\] <clusterId> <serverId>

This command removes the server passed in `serverId` from the cluster passed in `clusterId`.

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

## runtime-mgr cluster create

\> runtime-mgr cluster create \[options\] <name>

This command creates a cluster using the id passed in `name`.

Besides 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><p><code>--multicast</code></p></td><td><p>Whether cluster should be multicast</p></td></tr><tr><td><p><code>--server &lt;id:ip&gt;</code></p></td><td><p>Pair of server ID and IP address. Latter is optional for multicast cluster. Provide multiple values to add multiple servers</p></td></tr></tbody></table>

## runtime-mgr cluster describe

\> runtime-mgr cluster describe \[options\] <clusterId>

This command describes the cluster passed in `clusterId`.

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

## runtime-mgr cluster modify

\> runtime-mgr cluster modify \[options\] <clusterId>

This command modifies the cluster passed in `clusterId`.  
In order to update the id for the cluster, you need to pass the `--name` option.

Besides the `--name` option, this command also takes the default `--help`, `-f`/`--fields` and
`-o`/`--output` options.

<!-- document id=1f568ad43546dbc1b00af6fcca07ec8960e09df71923e3088b5ff5d08a21f55a url=/mulesoft/current/en-us/anypoint-cli/latest/server-clusters.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Local Server Clusters

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

Use the `cluster` commands to automate your Local Server Clusters processes. For more information
about how to use these commands, refer to the
[Runtime Manager documentation](https://docs.mulesoft.com/runtime-manager/).

<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-cluster-add-server">runtime-mgr:cluster:add:server</a></p></div></div></td><td><div><div><p>Adds server to cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-create">runtime-mgr:cluster:create</a></p></div></div></td><td><div><div><p>Creates new cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-describe">runtime-mgr:cluster:describe</a></p></div></div></td><td><div><div><p>Describes server cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-delete">runtime-mgr:cluster:delete</a></p></div></div></td><td><div><div><p>Deletes cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-modify">runtime-mgr:cluster:modify</a></p></div></div></td><td><div><div><p>Modifies cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-list">runtime-mgr:cluster:list</a></p></div></div></td><td><div><div><p>Lists all clusters in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-cluster-remove-server">runtime-mgr:cluster:remove:server</a></p></div></div></td><td><div><div><p>Removes server from a cluster</p></div></div></td></tr></tbody></table>

## runtime-mgr:cluster:add:server

\> runtime-mgr:cluster:add:server \[flags\] <clusterId> <serverId>

Adds the cluster in `clusterId` to the server passed in `serverId`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cluster:create

\> runtime-mgr:cluster:create <name> \[flags\]

This command creates a cluster using the id passed in `name`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--multicast</code></p></div></div></td><td><div><div><p>Whether cluster should be multicast</p></div></div></td><td><div><div><p><code>--multicast</code></p></div></div></td></tr><tr><td><div><div><p><code>--server</code></p></div></div></td><td><div><div><p>Pair of server ID and IP address<br>IP address is optional for multicast cluster<br>Provide multiple values to add multiple servers</p></div></div></td><td><div><div><p><code>--server 903083:192.168.0.1</code></p></div></div></td></tr></tbody></table>

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

## runtime-mgr:cluster:describe

\> runtime-mgr:cluster:describe \[flags\] <clusterId>

Describes the cluster passed in `clusterId`.

This command accepts the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cluster:delete

\> runtime-mgr:cluster:delete \[flags\] <clusterId>

Deletes the cluster passed in `clusterId`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

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

## runtime-mgr:cluster:list

\> runtime-mgr:cluster:list \[flags\]

Lists all clusters in the environment.

This command has the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cluster:modify

\> runtime-mgr:cluster:modify \[flags\] <clusterId>

Modifies the cluster passed in `clusterId`.  
In order to update the id for the cluster, you need to pass the `--name` flag.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:cluster:remove:server

\> runtime-mgr:cluster:remove:server \[flags\] <clusterId> <serverId>

Removes the server passed in `serverId` from the cluster passed in `clusterId`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=a041bbb3282fa4d6386ecb1a516904503c4b7ac599357e2e515e9fd62cab25af url=/mulesoft/current/en-us/anypoint-cli/3.x/server-groups.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Local Server Groups

> 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-servergroup-create">runtime-mgr serverGroup create</a></p></div></div></td><td><div><div><p>Creates server group from servers</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-describe">runtime-mgr serverGroup describe</a></p></div></div></td><td><div><div><p>Describes server group</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-modify">runtime-mgr serverGroup modify</a></p></div></div></td><td><div><div><p>Modifies server group</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-add-server">runtime-mgr serverGroup add server</a></p></div></div></td><td><div><div><p>Adds server to a server group</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-delete">runtime-mgr serverGroup delete</a></p></div></div></td><td><div><div><p>Deletes server group</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-list">runtime-mgr serverGroup list</a></p></div></div></td><td><div><div><p>Lists all server groups in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-remove-server">runtime-mgr serverGroup remove server</a></p></div></div></td><td><div><div><p>Removes server from a server group</p></div></div></td></tr></tbody></table>

## runtime-mgr serverGroup create

\> runtime-mgr serverGroup create \[options\] <name> \[serverIds...\]

This command creates a server group with the name passed in `name` using the server Id(s) passed as
argument(s) thereafter.

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

## runtime-mgr serverGroup describe

\> runtime-mgr serverGroup describe \[options\] <serverGroupId>

This command describes the server group passed in `serverGroupId`.

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

## runtime-mgr serverGroup modify

\> runtime-mgr serverGroup modify \[options\] <serverGroupId>

This command modifies the server group passed in `serverGroupId`.

In order to update the id for the cluster, you need to pass the `--name` option.

Besides the `--name` option, this command also takes the default `--help`, `-f`/`--fields` and
`-o`/`--output` options.

## runtime-mgr serverGroup add server

\> runtime-mgr serverGroup add server \[options\] <serverGroupId> <serverId>

This command adds the server passed in `serverId` to the server group passed in `serverGroupId`.

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

## runtime-mgr serverGroup delete

\> runtime-mgr serverGroup delete \[options\] <serverGroupId>

This command deletes the server groups passed in `serverGroupId`.

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

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

## runtime-mgr serverGroup list

\> runtime-mgr serverGroup list \[options\]

This command lists all server groups in the environment.

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

## runtime-mgr serverGroup remove server

\> runtime-mgr serverGroup remove server \[options\] <serverGroupId> <serverId>

This command removes the server passed in `serverId` from the server group passed in
`serverGroupId`.

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

<!-- document id=6a6ca345afc242af05dd94781c09627a1b0b68ab1f8a804a0a4831ed5dd492cf url=/mulesoft/current/en-us/anypoint-cli/latest/server-groups.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Local Server Groups

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

Use the `serverGroup` commands to automate your Local Server Groups processes. For more information
about how to use these commands, refer to the
[Runtime Manager documentation](https://docs.mulesoft.com/runtime-manager/).

<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-servergroup-add-server">runtime-mgr:serverGroup:add:server</a></p></div></div></td><td><div><div><p>Adds server to a server group</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-create">runtime-mgr:serverGroup:create</a></p></div></div></td><td><div><div><p>Creates server group from servers</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-describe">runtime-mgr:serverGroup:describe</a></p></div></div></td><td><div><div><p>Describes server group</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-delete">runtime-mgr:serverGroup:delete</a></p></div></div></td><td><div><div><p>Deletes server group</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-list">runtime-mgr:serverGroup:list</a></p></div></div></td><td><div><div><p>Lists all server groups in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-modify">runtime-mgr:serverGroup:modify</a></p></div></div></td><td><div><div><p>Modifies server group</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-servergroup-remove-server">runtime-mgr:serverGroup:remove:server</a></p></div></div></td><td><div><div><p>Removes server from a server group</p></div></div></td></tr></tbody></table>

## runtime-mgr:serverGroup:add:server

\> runtime-mgr:serverGroup:add:server \[flags\] <serverGroupId> <serverId>

Adds the server passed in `serverId` to the server group passed in `serverGroupId`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:serverGroup:create

\> runtime-mgr:serverGroup:create \[flags\] <name> \[serverIds...\]

Creates a server group with the name passed in `name` using the server Id(s) passed as argument(s)
thereafter.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:serverGroup:describe

\> runtime-mgr:serverGroup:describe \[flags\] <serverGroupId>

Describes the server group passed in `serverGroupId`.

This command accepts the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:serverGroup:delete

\> runtime-mgr:serverGroup:delete \[flags\] <serverGroupId>

Deletes the server groups passed in `serverGroupId`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

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

## runtime-mgr:serverGroup:list

\> runtime-mgr:serverGroup:list \[flags\]

Lists all server groups in the environment.

This command has the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:serverGroup:modify

\> runtime-mgr:serverGroup:modify \[flags\] <serverGroupId>

Modifies the server group passed in `serverGroupId`.

In order to update the id for the cluster, you need to pass the `--name` flag.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:serverGroup:remove:server

\> runtime-mgr:serverGroup:remove:server \[flags\] <serverGroupId> <serverId>

Removes the server passed in `serverId` from the server group passed in `serverGroupId`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=c4be4a2b0118a3abd2a4962d89d3f526a317eddaefee750c3a9e3c3350cedde8 url=/mulesoft/current/en-us/anypoint-cli/3.x/servers.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Local Servers

> 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-server-describe">runtime-mgr server describe</a></p></div></div></td><td><div><div><p>Describes server</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-server-modify">runtime-mgr server modify</a></p></div></div></td><td><div><div><p>Modifies server</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-server-token">runtime-mgr server token</a></p></div></div></td><td><div><div><p>Gets server registration token. This token needs to be used to register a new server</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-server-delete">runtime-mgr server delete</a></p></div></div></td><td><div><div><p>Deletes server</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-server-list">runtime-mgr server list</a></p></div></div></td><td><div><div><p>Changes an standalone application artifact</p></div></div></td></tr></tbody></table>

## runtime-mgr server describe

\> runtime-mgr server describe \[options\] <serverId>

This command describes the server passed in `serverId`.

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

## runtime-mgr server modify

\> runtime-mgr server modify \[options\] <serverId>

This command modifies the server passed in `serverId`.

In order to update the id for the cluster, you need to pass the `--name` option.

Besides the `--name` option, this command also takes the default `--help`, `-f`/`--fields` and
`-o`/`--output` options.

## runtime-mgr server token

\> runtime-mgr server token \[options\]

This command gets server registration token. This token needs to be used to register a new server.

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

## runtime-mgr server delete

\> runtime-mgr server delete \[options\] <serverId>

This command deletes the server passed in `serverId`.

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

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

## runtime-mgr server list

\> runtime-mgr server list \[options\]

This server lists all servers in your environment.

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

<!-- document id=d2a317caa6a313da5b126ebb6f15fb4d1f7913f202f9275d9ab41f098a19a656 url=/mulesoft/current/en-us/anypoint-cli/latest/servers.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Local Servers

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

Use the `servers` commands to automate your Local Servers processes. For more information about how
to use these commands, refer to the [Runtime Manager documentation](https://docs.mulesoft.com/runtime-manager/).

<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-server-describe">runtime-mgr:server:describe</a></p></div></div></td><td><div><div><p>Describes server</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-server-delete">runtime-mgr:server:delete</a></p></div></div></td><td><div><div><p>Deletes server</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-server-list">runtime-mgr:server:list</a></p></div></div></td><td><div><div><p>Changes an standalone application artifact</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-server-modify">runtime-mgr:server:modify</a></p></div></div></td><td><div><div><p>Modifies server</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-server-token">runtime-mgr:server:token</a></p></div></div></td><td><div><div><p>Gets server registration token. This token needs to be used to register a new server</p></div></div></td></tr></tbody></table>

## runtime-mgr:server:describe

\> runtime-mgr:server:describe \[flags\] <serverId>

Describes the server passed in `serverId`.

This command accepts the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:server:delete

\> runtime-mgr:server:delete \[flags\] <serverId>

Deletes the server passed in `serverId`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

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

## runtime-mgr:server:list

\> runtime-mgr:server:list \[flags\]

Lists all servers in your environment.

This command accepts the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:server:modify

\> runtime-mgr:server:modify \[flags\] <serverId>

Modifies the server passed in `serverId`.

In order to update the id for the cluster, you need to pass the `--name` flag.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:server:token

\> runtime-mgr:server:token \[flags\]

Gets server registration token. This token needs to be used to register a new server.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=369489488769c5f3dc55ca3a3991b7b00c835227a2be82f21b3ccc966c17af5c url=/mulesoft/current/en-us/anypoint-cli/latest/managed-gateways.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Managed Omni Gateways

> 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-gateways-managed-create">runtime-mgr:gateways:managed:create</a></p></div></div></td><td><div><div><p>Create a Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-gateways-managed-delete">runtime-mgr:gateways:managed:delete</a></p></div></div></td><td><div><div><p>Delete a Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-gateways-managed-describe">runtime-mgr:gateways:managed:describe</a></p></div></div></td><td><div><div><p>Describe a specific Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-gateways-managed-edit">runtime-mgr:gateways:managed:edit</a></p></div></div></td><td><div><div><p>Edit a Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-gateways-managed-list">runtime-mgr:gateways:managed:list</a></p></div></div></td><td><div><div><p>Lists all Managed Omni Gateways in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-gateways-managed-start">runtime-mgr:gateways:managed:start</a></p></div></div></td><td><div><div><p>Start a Managed Omni Gateway</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-gateways-managed-stop">runtime-mgr:gateways:managed:stop</a></p></div></div></td><td><div><div><p>Stop a Managed Omni Gateway</p></div></div></td></tr></tbody></table>

## runtime-mgr:gateways:managed:create

\> runtime-mgr:gateways:managed:create <name> <targetId> <size> \[flags\]

Creates a new Managed Omni Gateway with the specified configuration  
The gateway will be deployed to the specified `targetId`.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--releaseChannel</code></p></div></div></td><td><div><div><p>Release channel (required). Supported values: <code>edge</code>, <code>lts</code></p></div></div></td><td><div><div><p><code>--releaseChannel edge</code></p></div></div></td></tr><tr><td><div><div><p><code>--version</code></p></div></div></td><td><div><div><p>Runtime version. Use <code>latest</code> for the most recent version available for the configured release channel.<br>Default: <code>latest</code></p></div></div></td><td><div><div><p><code>--version 1.10.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--publicUrl</code></p></div></div></td><td><div><div><p>Public URL(s). For multiple URLs, separate them with commas</p></div></div></td><td><div><div><p><code>--publicUrl <a href="https://my-gateway.example.com/">https://my-gateway.example.com/</a></code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]lastMileSecurity</code></p></div></div></td><td><div><div><p>Enable or disable ingress last mile security.<br>Default: <code>false</code></p></div></div></td><td><div><div><p><code>--lastMileSecurity</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]forwardSslSession</code></p></div></div></td><td><div><div><p>Enable or disable ingress forward SSL session.<br>Default: <code>false</code></p></div></div></td><td><div><div><p><code>--forwardSslSession</code></p></div></div></td></tr><tr><td><div><div><p><code>--upstreamResponseTimeout</code></p></div></div></td><td><div><div><p>Upstream response timeout in seconds.<br>Default: <code>15</code></p></div></div></td><td><div><div><p><code>--upstreamResponseTimeout 30</code></p></div></div></td></tr><tr><td><div><div><p><code>--connectionIdleTimeout</code></p></div></div></td><td><div><div><p>Connection idle timeout in seconds.<br>Default: <code>60</code></p></div></div></td><td><div><div><p><code>--connectionIdleTimeout 120</code></p></div></div></td></tr><tr><td><div><div><p><code>--loggingLevel</code></p></div></div></td><td><div><div><p>Logging level. Supported values: <code>debug</code>, <code>info</code>, <code>warn</code>, <code>error</code>, <code>fatal</code>.<br>Default: <code>info</code></p></div></div></td><td><div><div><p><code>--loggingLevel debug</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]forwardLogs</code></p></div></div></td><td><div><div><p>Enable or disable log forwarding.<br>Default: <code>true</code></p></div></div></td><td><div><div><p><code>--no-forwardLogs</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]tracingEnabled</code></p></div></div></td><td><div><div><p>Enable or disable tracing.<br>Default: <code>false</code></p></div></div></td><td><div><div><p><code>--tracingEnabled</code></p></div></div></td></tr><tr><td><div><div><p><code>--tracingSampling</code></p></div></div></td><td><div><div><p>Tracing sampling percentage (1-100). Note: High values may impact performance.<br>Default: <code>1</code></p></div></div></td><td><div><div><p><code>--tracingSampling 50</code></p></div></div></td></tr><tr><td><div><div><p><code>--tracingLabels</code></p></div></div></td><td><div><div><p>Tracing labels attributes as JSON string</p></div></div></td><td><div><div><p><code>--tracingLabels '[{"type":"environment","name":"prod","keyName":"env","defaultValue":"production"}]'</code></p></div></div></td></tr></tbody></table>

## runtime-mgr:gateways:managed:delete

\> runtime-mgr:gateways:managed:delete <managedGatewayId> \[flags\]

Deletes a Managed Omni Gateway  
If the gateway has associated APIs, the command will display a list of those APIs and prevent
deletion until they are removed.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:gateways:managed:describe

\> runtime-mgr:gateways:managed:describe <managedGatewayId> \[flags\]

Displays detailed information about a specific Managed Omni Gateway

This command accepts the `--output` flag to specify the response format. Supported values are
`table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:gateways:managed:edit

\> runtime-mgr:gateways:managed:edit <managedGatewayId> \[flags\]

Edits the configuration of an existing Managed Omni Gateway. You must specify at least one flag to
modify. Only the specified flags will be updated; all other settings will remain unchanged.

> [!IMPORTANT] If you specify `--tracingLabels` or `--tracingSampling` without enabling tracing, the
> command will return an error.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--releaseChannel</code></p></div></div></td><td><div><div><p>Release channel. Supported values: <code>edge</code>, <code>lts</code></p></div></div></td><td><div><div><p><code>--releaseChannel lts</code></p></div></div></td></tr><tr><td><div><div><p><code>--version</code></p></div></div></td><td><div><div><p>Runtime version. Use <code>latest</code> for the most recent version</p></div></div></td><td><div><div><p><code>--version 1.10.3</code></p></div></div></td></tr><tr><td><div><div><p><code>--publicUrl</code></p></div></div></td><td><div><div><p>Public URL(s). For multiple URLs, separate them with commas</p></div></div></td><td><div><div><p><code>--publicUrl <a href="https://new-gateway.example.com/">https://new-gateway.example.com/</a></code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]lastMileSecurity</code></p></div></div></td><td><div><div><p>Enable or disable ingress last mile security</p></div></div></td><td><div><div><p><code>--no-lastMileSecurity</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]forwardSslSession</code></p></div></div></td><td><div><div><p>Enable or disable ingress forward SSL session</p></div></div></td><td><div><div><p><code>--forwardSslSession</code></p></div></div></td></tr><tr><td><div><div><p><code>--upstreamResponseTimeout</code></p></div></div></td><td><div><div><p>Upstream response timeout in seconds</p></div></div></td><td><div><div><p><code>--upstreamResponseTimeout 45</code></p></div></div></td></tr><tr><td><div><div><p><code>--connectionIdleTimeout</code></p></div></div></td><td><div><div><p>Connection idle timeout in seconds</p></div></div></td><td><div><div><p><code>--connectionIdleTimeout 180</code></p></div></div></td></tr><tr><td><div><div><p><code>--loggingLevel</code></p></div></div></td><td><div><div><p>Logging level. Supported values: <code>debug</code>, <code>info</code>, <code>warn</code>, <code>error</code>, <code>fatal</code></p></div></div></td><td><div><div><p><code>--loggingLevel error</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]forwardLogs</code></p></div></div></td><td><div><div><p>Enable or disable log forwarding</p></div></div></td><td><div><div><p><code>--no-forwardLogs</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]tracingEnabled</code></p></div></div></td><td><div><div><p>Enable or disable tracing</p></div></div></td><td><div><div><p><code>--tracingEnabled</code></p></div></div></td></tr><tr><td><div><div><p><code>--tracingSampling</code></p></div></div></td><td><div><div><p>Tracing sampling percentage (1-100)</p></div></div></td><td><div><div><p><code>--tracingSampling 75</code></p></div></div></td></tr><tr><td><div><div><p><code>--tracingLabels</code></p></div></div></td><td><div><div><p>Tracing labels attributes as JSON string</p></div></div></td><td><div><div><p><code>--tracingLabels '[{"type":"custom","name":"region","keyName":"region","defaultValue":"us-east"}]'</code></p></div></div></td></tr></tbody></table>

## runtime-mgr:gateways:managed:list

\> runtime-mgr:gateways:managed:list \[flags\]

Lists all Managed Omni Gateways in the current environment  
The list includes gateway IDs, names, statuses, runtime versions, and target information.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:gateways:managed:start

\> runtime-mgr:gateways:managed:start <managedGatewayId> \[flags\]

Starts a stopped Managed Omni Gateway

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:gateways:managed:stop

\> runtime-mgr:gateways:managed:stop <managedGatewayId> \[flags\]

Stops a running Managed Omni Gateway

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=3e4fa4f6c527f4ec43db1023fe473db57b2d1cf56c8268d179ca2c0c2019997a url=/mulesoft/current/en-us/anypoint-cli/3.x/runtime-fabric-apps.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Managing Apps in Runtime Fabric

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

Use these commands for managing applications in Runtime Fabric.

<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-application-delete">runtime-mgr application delete</a></p></div></div></td><td><div><div><p>Deletes an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-deploy">runtime-mgr application deploy</a></p></div></div></td><td><div><div><p>Deploys an application to a specified target using an Exchange application and runs the specified runtime version</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-describe">runtime-mgr application describe</a></p></div></div></td><td><div><div><p>Describes an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-describe-json">runtime-mgr application describe-json</a></p></div></div></td><td><div><div><p>Describes an application in a raw JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-download-logs">runtime-mgr application download-logs</a></p></div></div></td><td><div><div><p>Downloads logs of an application from a specification to a specified directory</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-list">runtime-mgr application list</a></p></div></div></td><td><div><div><p>Lists all applications in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-modify">runtime-mgr application modify</a></p></div></div></td><td><div><div><p>Modifies a deployed application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-start">runtime-mgr application start</a></p></div></div></td><td><div><div><p>Starts a stopped application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-stop">runtime-mgr application stop</a></p></div></div></td><td><div><div><p>Stops running an application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-application-tail-logs">runtime-mgr application tail-logs</a></p></div></div></td><td><div><div><p>Tails an application’s logs from a specification</p></div></div></td></tr></tbody></table>

## runtime-mgr application delete

\> runtime-mgr application delete \[options\] <appID>

Deletes the running application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

> [!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 application deploy

\> runtime-mgr application deploy \[options\] <appID> <deploymentTargetID> <runtimeVersion>
<artifactID>

Deploys the application specified in `<appID>` to the deployment target specified using the
following options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>ArtifactId</code></p></div></div></td><td><div><div><p>Artifact ID of the application retrieved from Exchange.</p></div></div></td><td><div><div><p><code>mule-test-plugin</code></p></div></div></td></tr><tr><td><div><div><p><code>deploymentTargetID</code></p></div></div></td><td><div><div><p>ID of the deployment target.<br>You can get this ID directly from Runtime Manager.</p></div></div></td><td><div><div><p><code>app.runetime</code></p></div></div></td></tr><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Name of the application to deploy.</p></div></div></td><td><div><div><p><code>testCloudhub2app</code></p></div></div></td></tr><tr><td><div><div><p><code>runtimeVersion</code></p></div></div></td><td><div><div><p>Runtime version of the deployment target.</p></div></div></td><td><div><div><p><code>1.0.1</code></p></div></div></td></tr></tbody></table>

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes
these options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>assetVersion</code></p></div></div></td><td><div><div><p>Version of the Exchange application to use.<br>Default: latest application version</p></div></div></td><td><div><div><p><code>2.0.4</code></p></div></div></td></tr><tr><td><div><div><p><code>clustered</code></p></div></div></td><td><div><div><p>Enables clustered nodes, which requires at least two replicas.<br>Default:.<code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><div><div><p><code>disableAmLogForwarding</code></p></div></div></td><td><div><div><p>Disables forwarding applications logs to Anypoint Monitoring.<br>Default: <code>enabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>forwardSslSession</code></p></div></div></td><td><div><div><p>Enables SSL session forwarding.<br>Default: <code>disabled</code><br>Values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><div><div><p><code>groupID</code></p></div></div></td><td><div><div><p>Group ID of the asset to deploy.<br>Default: selected organization ID</p></div></div></td><td><div><div><p><code>org.mule.test</code></p></div></div></td></tr><tr><td><div><div><p><code>javaVersion</code></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, Runtime Fabric 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><td><div><div><p><code>8</code></p></div></div></td></tr><tr><td><div><div><p><code>lastMileSecurity</code></p></div></div></td><td><div><div><p>Enables Last Mile Security.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>memory</code></p></div></div></td><td><div><div><p>The amount of memory allocated to each replica of a Mule application or API gateway.</p></div></div></td><td><div><div><p><code>0.7</code></p></div></div></td></tr><tr><td><div><div><p><code>objectStoreV2</code></p></div></div></td><td><div><div><p>Enables Object Store v2.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>pathRewrite</code></p></div></div></td><td><div><div><p>Supplies the base path expected by the HTTP listener in your application.<br>Format: must begin with <code>/</code></p></div></div></td><td><div><div><p><code>/http://localhost:3000</code></p></div></div></td></tr><tr><td><div><div><p><code>property</code></p></div></div></td><td><div><div><p>Sets a property.<br>Format: <code>name:value</code>. Can be specified multiple times.<br>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters.</p></div></div></td><td><div><div><p><code>--property "gcp.privateKey:dGVzdA\=\="</code></p></div></div></td></tr><tr><td><div><div><p><code>propertiesFile</code></p></div></div></td><td><div><div><p>Replaces all properties with values from a selected file.<br>Format: one or more lines in <code>name: value</code> style</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/properties.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>publicEndpoints</code></p></div></div></td><td><div><div><p>Supplies endpoints to reach via the public internet.<br>Format: separated by commas, no spaces</p></div></div></td><td><div><div><p><code>my-superapp-example:/status?limit=10</code></p></div></div></td></tr><tr><td><div><div><p><code>releaseChannel</code></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, Runtime Fabric 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><td><div><div><p><code>EDGE</code></p></div></div></td></tr><tr><td><div><div><p><code>replicas</code></p></div></div></td><td><div><div><p>Number of replicas. Must be above <code>0</code>.<br>Default: <code>1</code></p></div></div></td><td><div><div><p><code>2</code></p></div></div></td></tr><tr><td><div><div><p><code>replicaSize</code></p></div></div></td><td><div><div><p>Size of replicas in Vcores.<br>Default: <code>0.1</code></p></div></div></td><td><div><div><p><code>0.5</code></p></div></div></td></tr><tr><td><div><div><p><code>reservedCPU</code></p></div></div></td><td><div><div><p>The amount of vCPU guaranteed to the application and reserved for its use.</p></div></div></td><td><div><div><p><code>0.02</code></p></div></div></td></tr><tr><td><div><div><p><code>scopeLoggingConfig</code></p></div></div></td><td><div><div><p>Defines scope logging.<br>Format: <code>scopeName: logLevel</code>, separated by commas, no spaces</p></div></div></td><td><div><div><p><code>testscope1:WARN,testscope2:DEBUG</code></p></div></div></td></tr><tr><td><div><div><p><code>scopeLoggingConfigFile</code></p></div></div></td><td><div><div><p>Uploads a file to define scope logging.<br>Format: one tupple per line, style: <code>{scope: scopeName, logLevel: logLevelType}</code> enclosed with <code>{}</code> <code>()</code> or <code>[]</code></p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>secureProperty</code></p></div></div></td><td><div><div><p>Sets a secure property.<br>Format: <code>name:value</code>. Can be specified multiple times.<br>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters.</p></div></div></td><td><div><div><p><code>--secureProperty "gcp.privateKey:dGVzdA\=\="</code></p></div></div></td></tr><tr><td><div><div><p><code>updateStrategy</code></p></div></div></td><td><div><div><p>Updates the strategy used.<br>Default: <code>rolling</code></p></div></div></td><td><div><div><p><code>recreate</code></p></div></div></td></tr><tr><td><div><div><p><code>vCPULimit</code></p></div></div></td><td><div><div><p>The maximum amount of vCPU the application can use (the level to which it can burst). This is shared CPU on the worker node.</p></div></div></td><td><div><div><p><code>3.9</code></p></div></div></td></tr></tbody></table>

## runtime-mgr application describe

\> runtime-mgr application describe \[options\] <appID>

Displays information about the application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

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

## runtime-mgr application describe-json

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

Displays a raw JSON response from the application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

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

## runtime-mgr application download-logs

\> runtime-mgr application download-logs \[options\] <appID> <directory> <specID>

Downloads logs for the application specified in `<appID>` from the specification specified in
`<specID>` to the selected directory.

To get the `<appID>`, run the `runtime-mgr application list` command.

To get the `<specID>` run the `runtime-mgr application describe` command.

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

## runtime-mgr application list

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

Lists all applications in your organization.

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

## runtime-mgr application modify

\> runtime-mgr application modify \[options\] <appID> <certificateName>

Updates the settings of an existing application specified in `<appID>`. To get the `<appID>`, run
the `runtime-mgr application list` command.

Besides the default `--help`, `-f`/`--fields` and `-o`/`--output` options, this command also takes
these options:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>ArtifactId</code></p></div></div></td><td><div><div><p>ID of the application retrieved from Exchange.</p></div></div></td><td><div><div><p><code>mule-maven-plugin</code></p></div></div></td></tr><tr><td><div><div><p><code>assetVersion</code></p></div></div></td><td><div><div><p>Version of the Exchange application to use.<br>Default: latest application version</p></div></div></td><td><div><div><p><code>2.0.4</code></p></div></div></td></tr><tr><td><div><div><p><code>clustered</code></p></div></div></td><td><div><div><p>Enables clustered nodes, which requires at least two replicas.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><div><div><p><code>disableAmLogForwarding</code></p></div></div></td><td><div><div><p>Disables forwarding applications logs to Anypoint Monitoring.<br>Default: <code>enabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>forwardSslSession</code></p></div></div></td><td><div><div><p>Enables SSL session forwarding.<br>Default: <code>disabled</code><br>Values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>false</code></p></div></div></td></tr><tr><td><div><div><p><code>groupID</code></p></div></div></td><td><div><div><p>Group ID of the asset to deploy.<br>Default: selected organization ID.</p></div></div></td><td><div><div><p><code>org.mule.testgroup</code></p></div></div></td></tr><tr><td><div><div><p><code>lastMileSecurity</code></p></div></div></td><td><div><div><p>Enables Last Mile Security.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>objectStoreV2</code></p></div></div></td><td><div><div><p>Enables object store v2.<br>Default: <code>disabled</code><br>Supported values: <code>true</code>, <code>false</code></p></div></div></td><td><div><div><p><code>true</code></p></div></div></td></tr><tr><td><div><div><p><code>pathRewrite</code></p></div></div></td><td><div><div><p>Supplies the base path expected by the HTTP listener in your application.<br>Format: must begin with <code>/</code></p></div></div></td><td><div><div><p><code>/http://localhost:3000</code>.</p></div></div></td></tr><tr><td><div><div><p><code>property</code></p></div></div></td><td><div><div><p>Sets a property.<br>Format: <code>name:value</code>. Can be specified multiple times.<br>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters.</p></div></div></td><td><div><div><p><code>--property "gcp.privateKey:dGVzdA\=\="</code></p></div></div></td></tr><tr><td><div><div><p><code>propertiesFile</code></p></div></div></td><td><div><div><p>Replaces all properties with values from a selected file.<br>Format: one or more lines in <code>name: value</code> style</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/properties.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>publicEndpoints</code></p></div></div></td><td><div><div><p>Supplies endpoints to reach via the public internet.<br>Format: separated by commas, no spaces</p></div></div></td><td><div><div><p><code>my-superapp-example: /status?limit=10</code></p></div></div></td></tr><tr><td><div><div><p><code>replicas</code></p></div></div></td><td><div><div><p>Number of replicas. Must be above <code>0</code>.<br>Default: <code>1</code></p></div></div></td><td><div><div><p><code>2</code></p></div></div></td></tr><tr><td><div><div><p><code>replicaSize</code></p></div></div></td><td><div><div><p>Size of replicas in Vcores.<br>Default: <code>0.1</code></p></div></div></td><td><div><div><p><code>0.5</code></p></div></div></td></tr><tr><td><div><div><p><code>runtimeVersion</code></p></div></div></td><td><div><div><p>Runtime version of the deployment target.</p></div></div></td><td><div><div><p><code>1.0.1</code></p></div></div></td></tr><tr><td><div><div><p><code>scopeLoggingConfig</code></p></div></div></td><td><div><div><p>Defines scope logging.<br>Format: <code>scopeName: logLevel</code>, separated by commas, no spaces</p></div></div></td><td><div><div><p><code>testscope1:WARN,testscope2:DEBUG</code></p></div></div></td></tr><tr><td><div><div><p><code>scopeLoggingConfigFile</code></p></div></div></td><td><div><div><p>Uploads a file to define scope logging.<br>Format: 1 tupple per line, style: <code>{scope: scopeName, logLevel: logLevelType}</code> enclosed with <code>{}</code> <code>()</code> or <code>[]</code></p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.txt</code></p></div></div></td></tr><tr><td><div><div><p><code>secureProperty</code></p></div></div></td><td><div><div><p>Sets a secure property.<br>Format: <code>name:value</code>. Can be specified multiple times.<br>Enclose the property in quotes and escape the <code>:</code> and <code>=</code> characters.</p></div></div></td><td><div><div><p><code>--secureProperty "gcp.privateKey:dGVzdA\=\="</code></p></div></div></td></tr><tr><td><div><div><p><code>updateStrategy</code></p></div></div></td><td><div><div><p>Updates the strategy used.<br>Default: <code>rolling</code></p></div></div></td><td><div><div><p><code>recreate</code></p></div></div></td></tr></tbody></table>

## runtime-mgr application start

\> runtime-mgr application start \[options\] <appid>

Starts running the application specified in `<appid>`. To get this ID, run the
`runtime-mgr application list` command.

This command accepts only the default option `--help`.

## runtime-mgr application stop

\> runtime-mgr application stop \[options\] <appID>

Stops running the application specified in `<appID>`. To get this ID, run the
`runtime-mgr application list` command.

This command accepts only the default option `--help`.

## runtime-mgr application tail-logs

\> runtime-mgr:application:tail-logs \[options\] <appID> <specID>

Tails application logs for the application specificied in `<appID>` from the specification specified
in `<specID>`.

To get the `<appID>`, run the `runtime-mgr application list` command.

To get the `<specID>` run the `runtime-mgr application describe` command.

This command accepts only the default option `--help`.

<!-- document id=672c2dcdf40ded09a5d4e44234e5080f75e033df07565619488ea59b3f93a9cd url=/mulesoft/current/en-us/anypoint-cli/latest/pdk-plugin.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for PDK Policy Projects

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

Use the `policy-project` commands for creating Policy Development Kit (PDK) projects.  
See [Policy Development Kit documentation](https://docs.mulesoft.com/pdk/latest/policies-pdk-prerequisites) for more
information about developing custom policies with the PDK.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#policy-project-create">policy-project:create</a></p></div></div></td><td><div><div><p>Creates a custom policy definition project</p></div></div></td></tr></tbody></table>

## policy-project:create

\> policy-project:create \[flags\] <name>

Creates a custom policy definition project with the name specified in `<name>`

This command scaffolds a new project structure for developing a custom MuleSoft policy using the
Policy Development Kit (PDK).

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=2f4d60bc8f88e90aadee362372c29d879149db1e639fe54ad46dd3a7a582cb76 url=/mulesoft/current/en-us/anypoint-cli/3.x/rtf-instances.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Runtime Fabric Instances

> 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-rtf-list">runtime-mgr rtf list</a></p></div></div></td><td><div><div><p>Lists available Runtime Fabric instances</p></div></div></td></tr></tbody></table>

## runtime-mgr rtf list

\> runtime-mgr rtf list \[options\]

This command lists available Runtime Fabric instances.

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

For information about managing your Runtime Fabric instances using the command line, see
[Supported rtfctl Commands](https://docs.mulesoft.com/runtime-fabric/latest/install-rtfctl#supported-commands).

<!-- document id=8a7b73fe9b2b22bc119dd73f3d2ffc2524c94912ecfb5fb46f3472ae32c93fff url=/mulesoft/current/en-us/anypoint-cli/3.x/runtime-manager.md -->

---
product: Anypoint CLI
version: 3.x
---

# CLI for Runtime Manager

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

Anypoint CLI supports these Runtime Manager features:

- [Hybrid Applications](https://docs.mulesoft.com/anypoint-cli/3.x/standalone-apps)

- [Alerts for Hybrid Applications](https://docs.mulesoft.com/anypoint-cli/3.x/standalone-alerts)

- [Local Servers](https://docs.mulesoft.com/anypoint-cli/3.x/servers)

- [Local Cluster Servers](https://docs.mulesoft.com/anypoint-cli/3.x/server-clusters)

- [Local Server Groups](https://docs.mulesoft.com/anypoint-cli/3.x/server-groups)

<!-- document id=929fde9d0a7a49e8636bc1250ee9d9528b584eb191bea8f725f1b88f8c812326 url=/mulesoft/current/en-us/anypoint-cli/latest/runtime-manager.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Runtime Manager

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

Anypoint CLI supports these Runtime Manager features:

- [Hybrid Applications](https://docs.mulesoft.com/anypoint-cli/latest/standalone-apps)

- [Alerts for Hybrid Applications](https://docs.mulesoft.com/anypoint-cli/latest/standalone-alerts)

- [Local Servers](https://docs.mulesoft.com/anypoint-cli/latest/servers)

- [Local Server Clusters](https://docs.mulesoft.com/anypoint-cli/latest/server-clusters)

- [Local Server Groups](https://docs.mulesoft.com/anypoint-cli/latest/server-groups)

- [Managed Flex Gateways](https://docs.mulesoft.com/anypoint-cli/latest/managed-gateways)

<!-- document id=ef324a50e66b45f36992a330c77acf70e62bb4774dfd18ce1ae68f348a9c8acd url=/mulesoft/current/en-us/anypoint-cli/latest/secrets-manager.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# CLI for Secrets Manager

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

Use the `secrets-mgr` commands to automate your Secrets Manager processes. For more information
about how to use these commands, refer to the
[Secrets Manager documentation](https://docs.mulesoft.com/anypoint-security/index-secrets-manager).

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#secret-group-create">secrets-mgr:secret-group:create</a></p></div></div></td><td><div><div><p>Creates a new secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-group-delete">secrets-mgr:secret-group:delete</a></p></div></div></td><td><div><div><p>Deletes a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-group-describe">secrets-mgr:secret-group:describe</a></p></div></div></td><td><div><div><p>Shows details of a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-group-list">secrets-mgr:secret-group:list</a></p></div></div></td><td><div><div><p>Lists secret groups</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-group-modify">secrets-mgr:secret-group:modify</a></p></div></div></td><td><div><div><p>Modifies a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-shared-create">secrets-mgr:shared-secret:create</a></p></div></div></td><td><div><div><p>Creates a shared secret in a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-shared-describe">secrets-mgr:shared-secret:describe</a></p></div></div></td><td><div><div><p>Shows details of a shared secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-shared-list">secrets-mgr:shared-secret:list</a></p></div></div></td><td><div><div><p>Lists all shared secrets in a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-shared-modify">secrets-mgr:shared-secret:modify</a></p></div></div></td><td><div><div><p>Modifies a shared secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-shared-replace">secrets-mgr:shared-secret:replace</a></p></div></div></td><td><div><div><p>Replaces an existing shared secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-certificate-create">secrets-mgr:certificate:create</a></p></div></div></td><td><div><div><p>Creates a new certificate secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-certificate-describe">secrets-mgr:certificate:describe</a></p></div></div></td><td><div><div><p>Shows details of a certificate secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-certificate-list">secrets-mgr:certificate:list</a></p></div></div></td><td><div><div><p>Lists all certificate secrets in a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-certificate-modify">secrets-mgr:certificate:modify</a></p></div></div></td><td><div><div><p>Modifies a certificate secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-certificate-replace">secrets-mgr:certificate:replace</a></p></div></div></td><td><div><div><p>Replaces an existing certificate secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-keystore-create">secrets-mgr:keystore:create</a></p></div></div></td><td><div><div><p>Creates a new keystore secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-keystore-describe">secrets-mgr:keystore:describe</a></p></div></div></td><td><div><div><p>Shows details of a keystore secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-keystore-list">secrets-mgr:keystore:list</a></p></div></div></td><td><div><div><p>Lists all keystore secrets in a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-keystore-modify">secrets-mgr:keystore:modify</a></p></div></div></td><td><div><div><p>Modifies a keystore secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-keystore-replace">secrets-mgr:keystore:replace</a></p></div></div></td><td><div><div><p>Replaces an existing keystore secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-truststore-create">secrets-mgr:truststore:create</a></p></div></div></td><td><div><div><p>Creates a new truststore secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-truststore-describe">secrets-mgr:truststore:describe</a></p></div></div></td><td><div><div><p>Shows details of a truststore secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-truststore-list">secrets-mgr:truststore:list</a></p></div></div></td><td><div><div><p>Lists all truststore secrets in a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-truststore-modify">secrets-mgr:truststore:modify</a></p></div></div></td><td><div><div><p>Modifies a truststore secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-truststore-replace">secrets-mgr:truststore:replace</a></p></div></div></td><td><div><div><p>Replaces an existing truststore secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-context-create">secrets-mgr:tls-context:mule:create</a></p></div></div></td><td><div><div><p>Creates a new Mule TLS context secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-context-describe">secrets-mgr:tls-context:mule:describe</a></p></div></div></td><td><div><div><p>Shows details of a Mule TLS context secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-context-list">secrets-mgr:tls-context:mule:list</a></p></div></div></td><td><div><div><p>Lists all Mule TLS context secrets in a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-context-modify">secrets-mgr:tls-context:mule:modify</a></p></div></div></td><td><div><div><p>Modifies a Mule TLS context secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-context-replace">secrets-mgr:tls-context:mule:replace</a></p></div></div></td><td><div><div><p>Replaces an existing Mule TLS context secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-flex-create">secrets-mgr:tls-context:flex-gateway:create</a></p></div></div></td><td><div><div><p>Creates a new Omni Gateway TLS context secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-flex-describe">secrets-mgr:tls-context:flex-gateway:describe</a></p></div></div></td><td><div><div><p>Shows details of a Omni Gateway TLS context secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-flex-list">secrets-mgr:tls-context:flex-gateway:list</a></p></div></div></td><td><div><div><p>Lists all Omni Gateway TLS context secrets in a secret group</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-flex-modify">secrets-mgr:tls-context:flex-gateway:modify</a></p></div></div></td><td><div><div><p>Modifies a Omni Gateway TLS context secret</p></div></div></td></tr><tr><td><div><div><p><a href="#secret-TLS-flex-replace">secrets-mgr:tls-context:flex-gatway:replace</a></p></div></div></td><td><div><div><p>Replaces an existing Omni Gateway TLS context secret</p></div></div></td></tr></tbody></table>

## secrets-mgr:secret-group:create

\> secrets-mgr:secret-group:create \[flags\]

Creates a new secret group with the name specified by `--name`

Prompt the `--downloadable` flag if the secrets in this group are referenced in an API Manager
proxy.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:secret-group:delete

\> secrets-mgr:secret-group:delete \[flags\]

Deletes the secret group specified by `--id`

> [!WARNING] This command does not prompt for confirmation before deleting.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:secret-group:describe

\> secrets-mgr:secret-group:describe \[flags\]

Returns the details of a secret group specified by `--id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:secret-group:list

\> secrets-mgr:secret-group:list \[flags\]

Lists all your secret groups, including the name and ID

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:secret-group:modify

\> secrets-mgr:secret-group:modify \[flags\]

Modifies a secret group specified by `--id`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret group</p></div></div></td><td><div><div><p><code>--name TestSecretGroup</code></p></div></div></td></tr><tr><td><div><div><p><code>--downloadable</code></p></div></div></td><td><div><div><p>Secrets in this group are referenced in an API Manager proxy</p></div></div></td><td><div><div><p><code>--downloadable</code></p></div></div></td></tr><tr><td><div><div><p><code>--no-downloadable</code></p></div></div></td><td><div><div><p>Secrets in this group are not referenced in an API Manager proxy</p></div></div></td><td><div><div><p><code>--no-downloadable</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:shared-secret:create

\> secrets-mgr:shared-secret:create \[flags\]

Creates a new shared secret in the secret group specified by `--group-id`, using the name specified
by `--name` and the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Choose the shared secret type (required)<br>Options: <code>Blob</code>, <code>UsernamePassword</code>, <code>SymmetricKey</code>, <code>S3Credential</code></p></div></div></td><td><div><div><p><code>--type UsernamePassword</code></p></div></div></td></tr><tr><td><div><div><p><code>--content</code></p></div></div></td><td><div><div><p>Blob text content (for <code>blob</code> type secrets)</p></div></div></td><td><div><div><p><code>--type Blob --content example</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 01/01/2025</code></p></div></div></td></tr><tr><td><div><div><p><code>--key</code></p></div></div></td><td><div><div><p>Key value (for <code>SymmetricKey</code> type secrets)</p></div></div></td><td><div><div><p><code>--type SymmetricKey --key 49324329</code></p></div></div></td></tr><tr><td><div><div><p><code>--access-key-id</code></p></div></div></td><td><div><div><p>S3 access key id (for <code>S3Credential</code> type secrets)</p></div></div></td><td><div><div><p><code>--type S3Credential -access-key-id 03249348324</code></p></div></div></td></tr><tr><td><div><div><p><code>--secret-access-key</code></p></div></div></td><td><div><div><p>S3 secret access key (for <code>S3Credential</code> type secrets)</p></div></div></td><td><div><div><p><code>-type S3Credential -secret-access-key 00000000000</code></p></div></div></td></tr><tr><td><div><div><p><code>--secret-password</code></p></div></div></td><td><div><div><p>Password (for <code>UsernamePassword</code> type secrets)</p></div></div></td><td><div><div><p><code>-type UsernamePassword -secret-password testpassword12</code></p></div></div></td></tr><tr><td><div><div><p><code>--secret-username</code></p></div></div></td><td><div><div><p>Username (for <code>UsernamePassword</code> type secrets)</p></div></div></td><td><div><div><p><code>-type UsernamePassword -secret-username mulesoft-username</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:shared-secret:describe

\> secrets-mgr:shared-secret:describe \[flags\]

Returns the details of a shared secret specified by `--id` from the secret group specified by
`--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

> [!NOTE] The output does not include any sensitive or secret data.

## secrets-mgr:shared-secret:list

\> secrets-mgr:shared-secret:list \[flags\]

Lists all shared secrets in a secret group specified by `--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:shared-secret:modify

\> secrets-mgr:shared-secret:modify \[flags\]

Modifies the name or expiration date for a shared secret specified by `--id`, from the secret group
specified by `--group-id`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New name for the shared secret</p></div></div></td><td><div><div><p><code>--name TestSharedSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>New expiration date for the shared secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:secret-group:replace

\> secrets-mgr:shared-secret:replace \[flags\]

Replaces an existing shared secret specified by `--id`, from the secret group specified by
`--group-id`, using the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--id</code></p></div></div></td><td><div><div><p>Secret ID (required)</p></div></div></td><td><div><div><p><code>--id 6e8417f6-2ca7-417a-82b6-047189a18b53</code></p></div></div></td></tr><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret Group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Shared secret type (required)<br>The value must match the existing secret type.</p></div></div></td><td><div><div><p><code>--type Blob</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New name for your shared secret</p></div></div></td><td><div><div><p><code>--name TestSharedSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--content</code></p></div></div></td><td><div><div><p>Blob text content (for <code>blob</code> type secrets)</p></div></div></td><td><div><div><p><code>--type Blob --content example</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--key</code></p></div></div></td><td><div><div><p>Key value (for <code>SymmetricKey</code> type secrets)</p></div></div></td><td><div><div><p><code>--type SymmetricKey --key 49324329</code></p></div></div></td></tr><tr><td><div><div><p><code>--access-key-id</code></p></div></div></td><td><div><div><p>S3 access key id (for <code>S3Credential</code> type secrets)</p></div></div></td><td><div><div><p><code>--type S3Credential -access-key-id 03249348324</code></p></div></div></td></tr><tr><td><div><div><p><code>--secret-access-key</code></p></div></div></td><td><div><div><p>S3 secret access key (for <code>S3Credential</code> type secrets)</p></div></div></td><td><div><div><p><code>-type S3Credential -secret-access-key 00000000000</code></p></div></div></td></tr><tr><td><div><div><p><code>--secret-password</code></p></div></div></td><td><div><div><p>Password (for <code>UsernamePassword</code> type secrets)</p></div></div></td><td><div><div><p><code>-type UsernamePassword -secret-password testpassword12</code></p></div></div></td></tr><tr><td><div><div><p><code>--secret-username</code></p></div></div></td><td><div><div><p>Username (for <code>UsernamePassword</code> type secrets)</p></div></div></td><td><div><div><p><code>-type UsernamePassword -secret-username mulesoft-username</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:certificate:create

\> secrets-mgr:certificate:create \[flags\]

Creates a new certificate secret in the secret group specified by `--group-id`, using the name
specified by `--name` and the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret (required)</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Choose the certificate secret type (required)<br>Options: <code>PEM</code></p></div></div></td><td><div><div><p><code>--type PEM</code></p></div></div></td></tr><tr><td><div><div><p><code>--cert-file</code></p></div></div></td><td><div><div><p>Certificate file path</p></div></div></td><td><div><div><p><code>--cert-file ./example-cert.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:certificate:describe

\> secrets-mgr:certificate:describe \[flags\]

Returns the details of a certificate secret specified by `--id` from the secret group specified by
`--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

> [!NOTE] The output does not include any sensitive or secret data.

## secrets-mgr:certificate:list

\> secrets-mgr:certificate:list \[flags\]

Lists all certificate secrets in a secret group specified by `--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:certificate:modify

\> secrets-mgr:certificate:modify \[flags\]

Modifies the name or expiration date for a certificate secret specified by `--id` from the group
specified by `--group-id`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New name for the certificate secret</p></div></div></td><td><div><div><p><code>--name TestCertificateSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>New expiration date for the keystore secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:certificate:replace

\> secrets-mgr:certificate:replace \[flags\]

Replaces an existing certificate secret specified by `--id`, from the secret group specified by
`--group-id`, using the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--id</code></p></div></div></td><td><div><div><p>Secret ID (required)</p></div></div></td><td><div><div><p><code>--id 6e8417f6-2ca7-417a-82b6-047189a18b53</code></p></div></div></td></tr><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret Group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Certificate secret type (required)<br>The value must match the existing secret type</p></div></div></td><td><div><div><p><code>--type PEM</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New name for your shared secret</p></div></div></td><td><div><div><p><code>--name TestSharedSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--cert-file</code></p></div></div></td><td><div><div><p>Certificate file type</p></div></div></td><td><div><div><p><code>--cert-file ./example-cert.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:keystore:create

\> secrets-mgr:keystore:create \[flags\]

Creates a new keystore secret in the secret group specified by `--group-id`, using the name
specified by `--name` and the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret (required)</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Keystore secret type (required)<br>Options: <code>PEM</code>, <code>JKS</code>, <code>PKCS12</code>, <code>JCEKS</code></p></div></div></td><td><div><div><p><code>--type PEM</code></p></div></div></td></tr><tr><td><div><div><p><code>--algorithm</code></p></div></div></td><td><div><div><p>Key manager factory algorithm for <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> keystore secrets</p></div></div></td><td><div><div><p><code>--algorithm PKIX</code></p></div></div></td></tr><tr><td><div><div><p><code>--alias</code></p></div></div></td><td><div><div><p>Alias for the key used in <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> keystore secrets</p></div></div></td><td><div><div><p><code>--alias KeyAliasExample</code></p></div></div></td></tr><tr><td><div><div><p><code>--capath-file</code></p></div></div></td><td><div><div><p>CA path certificate file for <code>PEM</code> keystore secrets</p></div></div></td><td><div><div><p><code>--capath-file ./example-capath.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--key-file</code></p></div></div></td><td><div><div><p>Key file for PEM keystore secrets</p></div></div></td><td><div><div><p><code>--key-file ./example-key.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--key-passphrase</code></p></div></div></td><td><div><div><p>Passphrase required for <code>JKS</code>, <code>PKCS12</code> and <code>JCEKS</code> keystore secrets<br>Optional for <code>PEM</code> keystore secrets</p></div></div></td><td><div><div><p><code>--key-passphrase examplePassphrase</code></p></div></div></td></tr><tr><td><div><div><p><code>--keystore-file</code></p></div></div></td><td><div><div><p>Keystore filepath for <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> type secrets</p></div></div></td><td><div><div><p><code>--keystore-file ./keystorefile.jks</code></p></div></div></td></tr><tr><td><div><div><p><code>--store-passphrase</code></p></div></div></td><td><div><div><p>Passphrase for the <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> type secrets</p></div></div></td><td><div><div><p><code>--store-passphrase ExampleStorePassphrase</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:keystore:describe

\> secrets-mgr:keystore:describe \[flags\]

Returns the details of a keystore secret specified by `--id` from the secret group specified by
`--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

> [!NOTE] The output doesn’t include any sensitive or secret data.

## secrets-mgr:keystore:list

\> secrets-mgr:keystore:list \[flags\]

Lists all keystore secrets in a secret group specified by `--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:keystore:modify

\> secrets-mgr:keystore:modify \[flags\]

Modifies the name or expiration date for a keystore secret specified by `--id` from the group
specified by `--group-id`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New name for the keystore secret</p></div></div></td><td><div><div><p><code>--name TestKeystoreSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>New expiration date for the keystore secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:keystore:replace

\> secrets-mgr:keystore:replace \[flags\]

Replaces an existing keystore secret specified by `--id`, from the secret group specified by
`--group-id`, using the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--id</code></p></div></div></td><td><div><div><p>Secret ID (required)</p></div></div></td><td><div><div><p><code>--id 6e8417f6-2ca7-417a-82b6-047189a18b53</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Choose the keystore secret type (required)<br>Options: <code>PEM</code>, <code>JKS</code>, <code>PKCS12</code>, <code>JCEKS</code></p></div></div></td><td><div><div><p><code>--type PEM</code></p></div></div></td></tr><tr><td><div><div><p><code>--algorithm</code></p></div></div></td><td><div><div><p>Key manager factory algorithm for <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> keystore secrets</p></div></div></td><td><div><div><p><code>--algorithm PKIX</code></p></div></div></td></tr><tr><td><div><div><p><code>--alias</code></p></div></div></td><td><div><div><p>Alias for the key used in <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> keystore secrets</p></div></div></td><td><div><div><p><code>--alias KeyAliasExample</code></p></div></div></td></tr><tr><td><div><div><p><code>--capath-file</code></p></div></div></td><td><div><div><p>CA path certificate file for <code>PEM</code> keystore secrets</p></div></div></td><td><div><div><p><code>--capath-file ./example-capath.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--key-file</code></p></div></div></td><td><div><div><p>Key file for PEM keystore secrets</p></div></div></td><td><div><div><p><code>--key-file ./example-key.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--key-passphrase</code></p></div></div></td><td><div><div><p>Passphrase required for <code>JKS</code>, <code>PKCS12</code> and <code>JCEKS</code> keystore secrets<br>Optional for <code>PEM</code> keystore secrets</p></div></div></td><td><div><div><p><code>--key-passphrase examplePassphrase</code></p></div></div></td></tr><tr><td><div><div><p><code>--keystore-file</code></p></div></div></td><td><div><div><p>Keystore filepath for <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> type secrets</p></div></div></td><td><div><div><p><code>--keystore-file ./keystorefile.jks</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--store-passphrase</code></p></div></div></td><td><div><div><p>Passphrase for the <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> type secrets</p></div></div></td><td><div><div><p><code>--store-passphrase ExampleStorePassphrase</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:truststore:create

\> secrets-mgr:truststore:create \[flags\]

Creates a new truststore secret in the secret group specified by `--group-id`, using the name
specified by `--name` and the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret (required)</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Choose the truststore secret type (required)<br>Options: <code>PEM</code>, <code>JKS</code>, <code>PKCS12</code>, <code>JCEKS</code></p></div></div></td><td><div><div><p><code>--type PEM</code></p></div></div></td></tr><tr><td><div><div><p><code>--truststore-file</code></p></div></div></td><td><div><div><p>Truststore filepath (required)</p></div></div></td><td><div><div><p><code>--truststore-file ./truststorefile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--algorithm</code></p></div></div></td><td><div><div><p>Key manager factory algorithm for <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> keystore secrets</p></div></div></td><td><div><div><p><code>--algorithm SUNX509</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--store-passphrase</code></p></div></div></td><td><div><div><p>Passphrase required for <code>JKS</code>, <code>PKCS12</code> and <code>JCEKS</code> keystore secrets</p></div></div></td><td><div><div><p><code>--store-passphrase examplePassphrase</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:truststore:describe

\> secrets-mgr:truststore:describe \[flags\]

Returns the details of a truststore secret specified by `--id` from the secret group specified by
`--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

> [!NOTE] The output does not include any sensitive or secret data.

## secrets-mgr:truststore:list

\> secrets-mgr:truststore:list \[flags\]

Lists all truststore secrets in a secret group specified by `--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:truststore:modify

\> secrets-mgr:truststore:modify \[flags\]

Modifies the name or expiration date for a truststore secret specified by `--id` from the group
specified by `--group-id`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New name for the truststore secret</p></div></div></td><td><div><div><p><code>--name TestTruststoreSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>New expiration date for the truststore secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:truststore:replace

\> secrets-mgr:truststore:replace \[flags\]

Replaces an existing truststore secret specified by `--id`, from the secret group specified by
`--group-id`, using the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--id</code></p></div></div></td><td><div><div><p>Secret ID (required)</p></div></div></td><td><div><div><p><code>--id 6e8417f6-2ca7-417a-82b6-047189a18b53</code></p></div></div></td></tr><tr><td><div><div><p><code>--type</code></p></div></div></td><td><div><div><p>Choose the truststore secret type (required)<br>Options: <code>PEM</code>, <code>JKS</code>, <code>PKCS12</code>, <code>JCEKS</code></p></div></div></td><td><div><div><p><code>--type PEM</code></p></div></div></td></tr><tr><td><div><div><p><code>--truststore-file</code></p></div></div></td><td><div><div><p>Truststore filepath (required)</p></div></div></td><td><div><div><p><code>--truststore-file ./truststorefile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--algorithm</code></p></div></div></td><td><div><div><p>Key manager factory algorithm for <code>JKS</code>, <code>PKCS12</code>, and <code>JCEKS</code> keystore secrets</p></div></div></td><td><div><div><p><code>--algorithm SUNX509</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--store-passphrase</code></p></div></div></td><td><div><div><p>Passphrase required for <code>JKS</code>, <code>PKCS12</code> and <code>JCEKS</code> keystore secrets</p></div></div></td><td><div><div><p><code>--store-passphrase examplePassphrase</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:tls-context:mule:create

\> secrets-mgr:tls-context:mule:create \[flags\]

Creates a new Mule TLS context secret in the secret group specified by `--group-id`, and using the
name specified by `--name`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret (required)</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--tls-version</code></p></div></div></td><td><div><div><p>TLS Version<br>Default: TLSv1.2</p></div></div></td><td><div><div><p><code>--tls-version TLSv1.1</code></p></div></div></td></tr><tr><td><div><div><p><code>--cipher</code></p></div></div></td><td><div><div><p>Cipher for the specified TLS version</p></div></div></td><td><div><div><p><code>--cipher TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--insecure</code></p></div></div></td><td><div><div><p>Disable certificate validation</p></div></div></td><td><div><div><p><code>--insecure</code></p></div></div></td></tr><tr><td><div><div><p><code>--keystore-id</code></p></div></div></td><td><div><div><p>A valid <code>JKS</code>, <code>JCEKS</code>, or <code>PKCS12</code> keystore ID in the secret group, which is used as keystore for the TLS context</p></div></div></td><td><div><div><p><code>--keystore-id 2d773060-aed0-46a7-b131-efbdb6ceff70</code></p></div></div></td></tr><tr><td><div><div><p><code>--truststore-id</code></p></div></div></td><td><div><div><p>A valid <code>JKS</code>, <code>JCEKS</code>, or <code>PKCS12</code> truststore ID in the secret group, which is used as truststore for the TLS context</p></div></div></td><td><div><div><p><code>--truststore-id 588c33e4-7f6f-44be-94e8-8b65a56d1670</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:tls-context:mule:describe

\> secrets-mgr:tls-context:mule:describe \[flags\]

Returns the details of a Mule TLS context secret specified by `--id` from the secret group specified
by `--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

> [!NOTE] The output does not include any sensitive or secret data.

## secrets-mgr:tls-context:mule:list

\> secrets-mgr:tls-context:mule:list \[flags\]

Lists all Mule TLS context secrets in a secret group specified by `--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:tls-context:mule:modify

\> secrets-mgr:TLS-context:mule:modify \[flags\]

Modifies the name or expiration date for a Mule TLS context secret specified by `--id` from the
group specified by `--group-id`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New name for the truststore secret</p></div></div></td><td><div><div><p><code>--name TestTruststoreSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>New expiration date for the truststore secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:tls-context:mule:replace

\> secrets-mgr:tls:context:mule:replace \[flags\]

Replaces an existing Mule TLS context secret specified by `--id`, from the secret group specified by
`--group-id`, using the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret (required)</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--tls-version</code></p></div></div></td><td><div><div><p>TLS Version<br>Default: TLSv1.2</p></div></div></td><td><div><div><p><code>--tls-version TLSv1.1</code></p></div></div></td></tr><tr><td><div><div><p><code>--cipher</code></p></div></div></td><td><div><div><p>Cipher for the specified TLS version</p></div></div></td><td><div><div><p><code>--cipher TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--insecure</code></p></div></div></td><td><div><div><p>Disable certificate validation</p></div></div></td><td><div><div><p><code>--insecure</code></p></div></div></td></tr><tr><td><div><div><p><code>--keystore-id</code></p></div></div></td><td><div><div><p>A valid <code>JKS</code>, <code>JCEKS</code>, or <code>PKCS12</code> keystore ID in the secret group, which is used as keystore for the TLS context</p></div></div></td><td><div><div><p><code>--keystore-id 2d773060-aed0-46a7-b131-efbdb6ceff70</code></p></div></div></td></tr><tr><td><div><div><p><code>--truststore-id</code></p></div></div></td><td><div><div><p>A valid <code>JKS</code>, <code>JCEKS</code>, or <code>PKCS12</code> truststore ID in the secret group, which is used as truststore for the TLS context</p></div></div></td><td><div><div><p><code>--truststore-id 588c33e4-7f6f-44be-94e8-8b65a56d1670</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:tls-context:flex-gateway:create

\> secrets-mgr:tls-context:flex-gateway:create \[flags\]

Creates a new Omni Gateway TLS context secret in the secret group specified by `--group-id`, and
using the name specified by `--name`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret (required)</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--max-tls-version</code></p></div></div></td><td><div><div><p>Maximum TLS Version<br>Default: TLSv1.3</p></div></div></td><td><div><div><p><code>--max-tls-version TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--min-tls-version</code></p></div></div></td><td><div><div><p>Minimum TLS Version<br>Default: TLSv1.3</p></div></div></td><td><div><div><p><code>--min-tls-version TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--cipher</code></p></div></div></td><td><div><div><p>Cipher for the specified TLS version range</p></div></div></td><td><div><div><p><code>--cipher TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256</code></p></div></div></td></tr><tr><td><div><div><p><code>--alpn-protocol</code></p></div></div></td><td><div><div><p>ALPN Protocol<br>Options: <code>h2</code>, <code>http/1.1</code></p></div></div></td><td><div><div><p><code>--alpn-protocol h2</code></p></div></div></td></tr><tr><td><div><div><p><code>--enable-client-cert-validation</code></p></div></div></td><td><div><div><p>Enable client certificate validation</p></div></div></td><td><div><div><p><code>--enable-client-cert-validation</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--keystore-id</code></p></div></div></td><td><div><div><p>A valid <code>PEM</code> keystore ID in the secret group, which is used as keystore for the TLS context</p></div></div></td><td><div><div><p><code>--keystore-id 2d773060-aed0-46a7-b131-efbdb6ceff70</code></p></div></div></td></tr><tr><td><div><div><p><code>--truststore-id</code></p></div></div></td><td><div><div><p>A valid <code>PEM</code> truststore ID in the secret group, which is used as truststore for the TLS context</p></div></div></td><td><div><div><p><code>--truststore-id 588c33e4-7f6f-44be-94e8-8b65a56d1670</code></p></div></div></td></tr><tr><td><div><div><p><code>--skip-server-cert-validation</code></p></div></div></td><td><div><div><p>Skip service certificate validation</p></div></div></td><td><div><div><p><code>--skip-server-cert-validation</code></p></div></div></td></tr></tbody></table>

For more information about ciphers, see
[Flex Gateway Supported Ciphers](https://docs.mulesoft.com/gateway/latest/conn-tls-config#supported-ciphers).

## secrets-mgr:tls-context:flex-gateway:describe

\> secrets-mgr:tls-context:flex-gateway:describe \[flags\]

Returns the details of an Omni Gateway TLS context secret specified by `--id` from the secret group
specified by `--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

> [!NOTE] The output does not include any sensitive or secret data.

## secrets-mgr:tls-context:flex-gateway:list

\> secrets-mgr:tls-context:flex-gateway:list \[flags\]

Lists all Omni Gateway TLS context secrets in a secret group specified by `--group-id`

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## secrets-mgr:tls-context:flex-gateway:modify

\> secrets-mgr:TLS-context:flex-gateway:modify \[flags\]

Modifies the name or expiration date for an Omni Gateway TLS context secret specified by `--id` from
the group specified by `--group-id`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>New name for the truststore secret</p></div></div></td><td><div><div><p><code>--name TestTruststoreSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>New expiration date for the truststore secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr></tbody></table>

## secrets-mgr:tls-context:flex-gateway:replace

\> secrets-mgr:tls:context:flex-gateway:replace \[flags\]

Replaces an existing Omni Gateway TLS context secret specified by `--id`, from the secret group
specified by `--group-id`, using the type specified by `--type`

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--group-id</code></p></div></div></td><td><div><div><p>Secret group ID (required)</p></div></div></td><td><div><div><p><code>--group-id 1fec0a49-1551-4199-bfcc-cf0352d0f29d</code></p></div></div></td></tr><tr><td><div><div><p><code>--name</code></p></div></div></td><td><div><div><p>Name for your secret (required)</p></div></div></td><td><div><div><p><code>--name TestSecret</code></p></div></div></td></tr><tr><td><div><div><p><code>--max-tls-version</code></p></div></div></td><td><div><div><p>Maximum TLS Version<br>Default: TLSv1.3</p></div></div></td><td><div><div><p><code>--max-tls-version TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--min-tls-version</code></p></div></div></td><td><div><div><p>Minimum TLS Version<br>Default: TLSv1.3</p></div></div></td><td><div><div><p><code>--min-tls-version TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--cipher</code></p></div></div></td><td><div><div><p>Cipher for the specified TLS version range</p></div></div></td><td><div><div><p><code>--cipher TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256</code></p></div></div></td></tr><tr><td><div><div><p><code>--alpn-protocol</code></p></div></div></td><td><div><div><p>ALPN Protocol<br>Options: <code>h2</code>, <code>http/1.1</code></p></div></div></td><td><div><div><p><code>--alpn-protocol h2</code></p></div></div></td></tr><tr><td><div><div><p><code>--enable-client-cert-validation</code></p></div></div></td><td><div><div><p>Enable client certificate validation</p></div></div></td><td><div><div><p><code>--enable-client-cert-validation</code></p></div></div></td></tr><tr><td><div><div><p><code>--expiration-date</code></p></div></div></td><td><div><div><p>Expiration date for the secret</p></div></div></td><td><div><div><p><code>--expiration-date 2025-01-25</code></p></div></div></td></tr><tr><td><div><div><p><code>--keystore-id</code></p></div></div></td><td><div><div><p>A valid <code>PEM</code> keystore ID in the secret group, which is used as keystore for the TLS context</p></div></div></td><td><div><div><p><code>--keystore-id 2d773060-aed0-46a7-b131-efbdb6ceff70</code></p></div></div></td></tr><tr><td><div><div><p><code>--truststore-id</code></p></div></div></td><td><div><div><p>A valid <code>PEM</code> truststore ID in the secret group, which is used as truststore for the TLS context</p></div></div></td><td><div><div><p><code>--truststore-id 588c33e4-7f6f-44be-94e8-8b65a56d1670</code></p></div></div></td></tr><tr><td><div><div><p><code>--skip-server-cert-validation</code></p></div></div></td><td><div><div><p>Skip service certificate validation</p></div></div></td><td><div><div><p><code>--skip-server-cert-validation</code></p></div></div></td></tr></tbody></table>

<!-- document id=aacb8cab359455bfd1f6b2696d7a897c745c6963f7ee450cc0bfb8ee64ef9767 url=/mulesoft/current/en-us/anypoint-cli/latest/diff-earlier-ver.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# How Version 4.x Differs from Previous Versions

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

Scripts that use versions of the Anypoint Platform CLI earlier than 4.x do not automatically use
Anypoint CLI 4.x commands because the new version of the CLI has different command names and syntax.
However, because the CLI version 4.x name and install package are different from previous versions,
you can install Anypoint CLI 4.x and an earlier version on the same system and use both versions in
your scripts.

Warning: Anypoint CLI 4.x is not backward compatible with previous versions.

## Changes

Anypoint CLI 4.x introduces the following changes:

- **CLI Name** The new CLI is named `anypoint-cli-v4`.

- **Installation** Command groups for Anypoint Platform components are packaged as plugins that can
  optionally be installed and uninstalled separately from the core installation package.

- **Authentication**

  - Set your credentials using the `anypoint-cli-v4 conf` command.

  - The only way to authenticate to Anypoint CLI 4.x is through
    [Connected Apps](https://docs.mulesoft.com/access-management/connected-apps-overview).

- **Command Syntax** The separator between command parameters can be either a colon (:) or a space.
  For example, the command to get the Exchange asset resource list can be either
  `anypoint-cli-v4 exchange:asset:resource:list` or `anypoint-cli-v4 exchange asset resource list`.

- **Commands and Properties** The following commands and properties have changed:

  - `exchange:asset:upload` replaces `exchange:asset:uploadv2`.

  - `exchange:asset:upload --properties='{"property1":"value2", "property2": "value2"}'` replaces
    `exchange:asset:upload properties.value1.value2`.

  - `cloudhub:load-balancer:allowlist:add/remove` commands replace the similar commands that used a
    non-inclusive term.

  - `runtime-mgr:cloudhub-application:describe -o JSON` replaces
    `runtime-mgr cloudhub-application describe-json`.

  - `runtime-mgr:pcf-application:describe -o JSON` replaces
    `runtime-mgr pcf-application describe-json`.

  - `cloudhub:vpc:describe -o JSON` replaces `cloudhub vpc describe-json`.

  - Environments and Business Groups commands are no longer supported.

  - Datagraph API Source Management commands are no longer supported.

  - Runtime Fabric Instances commands are no longer supported.

- **Interactive Mode** Because interactive mode is no longer supported, the following commands and
  flags are no longer available:

  - `use business-group` command

  - `use environment` command

  - `exit` command

  - `-f, --fields` flag

  - Ability to interactively enter the password if you omit it

- When using multi-option flags in a command in Anypoint CLI 4.x,you need to either put the
  parameter before the flags or use a `--` (two dashes followed by a space) before the parameter to
  make it work.

<!-- document id=a368d6d3155134e767d105551f63305ea4298ba45ce9a07c692ebf5b18768739 url=/mulesoft/current/en-us/anypoint-cli/latest/install.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Install Anypoint CLI 4.x

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

Install Anypoint Platform CLI 4.x from npm to access command-line tools for Anypoint Platform and
Anypoint Platform Private Cloud Edition (PCE). The installation process includes
[installing prerequisite software](#prereqs),
[installing the CLI package with default plugins](#installation), and optionally
[installing nondefault plugins](#install-plugins). [Verify the installation](#verify-installation)
to ensure proper setup for automating platform operations and managing applications. CLI supports
both cloud and on-premises deployments, enabling integration with CI/CD workflows and enterprise
environments.

## Before You Begin

The Anypoint CLI is built with Node.js and is installed by using npm, the package manager for the
Node JavaScript platform.

Versions required are as follows:

- Node.js version 22.0.0 or later

- npm version 7 or later

To install the prerequisite software:

- Download and install Node.js and npm.

  See the [NodeJS download page](https://nodejs.org/en/download/).

Depending on the configuration of your system, you might need to log in using administrator
credentials before you can successfully run the npm commands.

## Install the Core Package and Default Plugins

Run the following command to install the Anypoint CLI core package and all default plugins. See
[List of Plugins](#plugin-list).

```text
npm install -g anypoint-cli-v4-public
```

## Install a Plugin Separately

After installing the Anypoint CLI 4.x core package, you can install nondefault plugins or new
versions of default plugins as follows:

```text
anypoint-cli-v4 plugins:install <plugin-name>
```

For example, to install the account plugin, use the following command:

```text
anypoint-cli-v4 plugins:install anypoint-cli-account-plugin
```

### List of Plugins

You can install the following plugins with Anypoint CLI:

<table><colgroup><col> <col></colgroup><thead><tr><th>Plugin</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>anypoint-cli-account-plugin</p></div></div></td><td><div><div><p>Account command topics</p></div></div></td></tr><tr><td><div><div><p>mulesoft-anypoint-cli-agent-fabric-plugin</p></div></div></td><td><div><div><p>Agent Fabric command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-api-manager-plugin</p></div></div></td><td><div><div><p>API Manager command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-cloudhub-plugin</p></div></div></td><td><div><div><p>CloudHub and CloudHub 2.0 command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-datagraph-plugin</p></div></div></td><td><div><div><p>Anypoint DataGraph command topics</p></div></div></td></tr><tr><td><div><div><p>@salesforce/anypoint-cli-dx-mule-plugin</p></div></div></td><td><div><div><p>DX Mule command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-exchange-plugin</p></div></div></td><td><div><div><p>Exchange command topics</p></div></div></td></tr><tr><td><div><div><p>mulesoft-anypoint-cli-designcenter-plugin</p></div></div></td><td><div><div><p>Design Center command topics</p></div></div></td></tr><tr><td><div><div><p>mulesoft-anypoint-cli-governance-plugin</p></div></div></td><td><div><div><p>API Governance command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-runtime-mgr-plugin</p></div></div></td><td><div><div><p>Runtime Manager command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-secrets-mgr-plugin</p></div></div></td><td><div><div><p>Secrets Manager command topics</p></div></div></td></tr></tbody></table>

> [!NOTE] The API Governance plugin npm package name is now
> `mulesoft-anypoint-cli-governance-plugin`. The old name `anypoint-cli-governance-plugin` is
> deprecated. If you use the old name, see
> [Migrate to the New Governance Plugin Package Name](#migrate-governance-plugin).

#### Migrate to the New Governance Plugin Package Name

To migrate to the new package name `mulesoft-anypoint-cli-governance-plugin`:

1.  In your `package.json` file, replace the `"anypoint-cli-governance-plugin": "1.0.x"` dependency
    with `"mulesoft-anypoint-cli-governance-plugin": "1.0.19"`.

2.  For oclif hosts, such as Anypoint CLI v4, update the entry in the `oclif.plugins` array from
    `"anypoint-cli-governance-plugin"` to `"mulesoft-anypoint-cli-governance-plugin"`.

3.  Run `npm install` to refresh your lockfile.

4.  Regenerate the oclif manifest and README by running `oclif manifest && oclif readme` if your
    host publishes one.

## Verify the Installation

After you install Anypoint CLI you can verify the installation using commands to:

- [View the Core Package Version](#view-core-version)

- [View the List of Plugins Installed](#view-plugin-list)

- [View All Version Information](#view-all-version-info)

### View the Core Package Version

To view the version of the core package:

```text
anypoint-cli-v4 --version
```

The output shows the version of the installed core package as follows:

anypoint-cli-v4/1.x.x <OS-version> node-v16.x.x

### View the List of Plugins Installed

To verify a plugin installation and view a list of all installed plugins, use the following command:

```text
anypoint-cli-v4
```

The output shows the installed plugins under the `TOPICS` section. The following example shows that
only the account plugin is installed:

VERSION anypoint-cli-v4/x.x.x <OS-version> node-vx.x.x

USAGE $ anypoint-cli-v4 \[COMMAND\]

TOPICS account Show details of a business group. If "name" is omitted, defaults to the current
session's business group plugins list installed plugins

COMMANDS help display help for anypoint-cli plugins list installed plugins

### View All Version Information

To see the list of installed plugins along with full version information, use the following command:

```text
anypoint-cli-v4 plugins --core
```

The output shows the version information:

$ anypoint-cli-v4 plugins --core @oclif/plugin-help 5.1.15 (core) @oclif/plugin-not-found 2.3.4
(core) @oclif/plugin-plugins 2.1.2 (core) @oclif/plugin-version 1.1.3 (core)
anypoint-cli-account-plugin 1.0.0 (core) anypoint-cli-api-mgr-plugin 1.0.0 (core)
anypoint-cli-cloudhub-plugin 1.0.0 (core) anypoint-cli-command 1.0.1 (core)
anypoint-cli-designcenter-plugin 1.0.2 (core) anypoint-cli-exchange-plugin 1.0.0 (core) └─conf-cli
0.1.9 (core) anypoint-cli-runtime-mgr-plugin 1.0.0 (core) anypoint-cli-v4 1.0.2 (core)

## Link a Local Plugin for Development

To link a local plugin directory into the CLI for development purposes:

```text
anypoint-cli-v4 plugins:link <path>
```

For example, to link a plugin in the current directory:

```text
anypoint-cli-v4 plugins:link .
```

> [!NOTE] Installing a linked plugin overrides a user-installed or core plugin that has the same
> commands.

## Enable Shell Autocomplete

To display autocomplete installation instructions for your shell:

```text
anypoint-cli-v4 autocomplete [bash|zsh|powershell]
```

For example, to set up autocomplete for Zsh:

```text
anypoint-cli-v4 autocomplete zsh
```

To refresh the autocomplete cache after installing new plugins:

```text
anypoint-cli-v4 autocomplete --refresh-cache
```

## Uninstall a Plugin

Uninstall plugins if, for example, you want to reduce the number to only those you use regularly.

To uninstall a plugin:

```text
anypoint-cli-v4 plugins:uninstall anypoint-cli-<plugin-name>-plugin
```

For example, the following command uninstalls the account plugin:

```text
anypoint-cli-v4 plugins:uninstall anypoint-cli-account-plugin
```

See [List of Plugins](#plugin-list).

## Uninstall Anypoint CLI

You might want to uninstall Anypoint CLI from systems where it is no longer being used.

To uninstall the Anypoint CLI:

```text
npm uninstall -g anypoint-cli-v4-public
```

<!-- document id=64126854d04994d903e58bc1e9406b0afb3a1ddb21d35ec3c7ca6204d3482b3c url=/mulesoft/current/en-us/anypoint-cli/latest/standalone-apps.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Locally Deployed Applications Managed by Runtime Manager

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

Use these commands to control applications deployed to your local Mule server and managed with
Runtime Manager. For more information about how to use these commands, refer to the
[Runtime Manager documentation](https://docs.mulesoft.com/runtime-manager/).

> [!CAUTION] For the Anypoint Platform CLI to recognize your target servers, each server must be
> manually registered with the platform.

<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-standalone-application-artifact">runtime-mgr:standalone-application:artifact</a></p></div></div></td><td><div><div><p>Downloads a standalone application artifact binary</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-copy">runtime-mgr:standalone-application:copy</a></p></div></div></td><td><div><div><p>Copies a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-delete">runtime-mgr:standalone-application:delete</a></p></div></div></td><td><div><div><p>Deletes a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-deploy">runtime-mgr:standalone-application:deploy</a></p></div></div></td><td><div><div><p>Deploys or redeploys an application to an on-premises server, server group, or cluster</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-describe">runtime.mgr:standalone-application:describe</a></p></div></div></td><td><div><div><p>Shows detailed information for a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-list">runtime-mgr:standalone-application:list</a></p></div></div></td><td><div><div><p>Lists all standalone applications in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-modify">runtime-mgr:standalone-application:modify</a></p></div></div></td><td><div><div><p>Changes a standalone application artifact</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-restart">runtime-mgr:standalone-application:restart</a></p></div></div></td><td><div><div><p>Restarts a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-start">runtime-mgr:standalone-application:start</a></p></div></div></td><td><div><div><p>Starts a standalone application</p></div></div></td></tr><tr><td><div><div><p><a href="#runtime-mgr-standalone-application-stop">runtime-mgr:standalone-application:stop</a></p></div></div></td><td><div><div><p>Stops a standalone application</p></div></div></td></tr></tbody></table>

## runtime-mgr:standalone-application:artifact

\> runtime-mgr:standalone-application:artifact \[flags\] <identifier> <directory>

Downloads the application artifact of the `identifier` application, to the directory passed in
`directory`. The `identifier` flag can be either an application ID or name.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:standalone-application:copy

\> runtime-mgr:standalone-application:copy \[flags\] <source> <target> <targetIdentifier>

Copies the standalone (on-premises) application passed in `source` to the target passed in `target`
and the server, server group or cluster ID or Name passed in `targetIdentifier`.

Both arguments `source` and `destination` are represented using the format:
`<organizationName>:<environmentName>/<appName>`, for example:

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

Copies the application named `application-1` from the QA environment of the _Services_ organization
to the QA environment of the `_Development_` organization in the server ID 123456.

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:standalone-application:copy application-1 Development/QA/application-2 123456

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

> [!WARNING] It isn’t possible to copy applications that have the same name but different targets
> within the same organization and environment. This can only be done through the UI.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:standalone-application:delete

\> runtime-mgr:standalone-application:delete \[flags\] <identifier>

Deletes the standalone (on-premises) application passed in `identifier`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

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

## runtime-mgr:standalone-application:deploy

\> runtime-mgr:standalone-application:deploy \[flags\] <targetIdentifier> <name> <zipfile>

Deploys or redeploys the application passed as a ZIP file in the path `zipfile` to the on-premises
target passed in `targetIdentifier`.

The `targetIdentifier` flag can be either a target ID or name.

A target can be either a server, server group, or cluster.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

To redeploy an app and set a logging level or turn on Insight event tracking, see
[runtime-mgr:standalone-application:modify](#runtime-mgr-standalone-application-modify).

## runtime-mgr:standalone-application:describe

\> runtime-mgr:standalone-application:describe \[flags\] <identifier>

Shows detailed information, such as status, creation date, and last update, for the standalone
(on-premises) application passed in `identifier`.

Use the flag `-o json` to get the raw JSON response of the application you specify in `<name>`.

This command accepts the `--output` flag. Use the `--output` flag to specify the response format.
Supported values are `table` (default) and `json`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:standalone-application:list

\> runtime-mgr:standalone-application:list \[flags\]

Lists all standalone (on-premises) applications.

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--limit</code></p></div></div></td><td><div><div><p>Specifies the number of results to retrieve</p></div></div></td><td><div><div><p><code>--limit 50</code></p></div></div></td></tr><tr><td><div><div><p><code>--offset</code></p></div></div></td><td><div><div><p>Offsets the number of applications passed</p></div></div></td><td><div><div><p><code>--offset 20</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specifies the response format.</p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr></tbody></table>

## runtime-mgr:standalone-application:modify

\> runtime-mgr:standalone-application:modify \[flags\] <identifier> <zipfile>

Modifies the standalone (on-premises) application passed in `identifier` with the ZIP file
application passed in `zipfile` as a path.

The `identifier` option specifies the application identifier. To retrieve the identifier, see
[runtime-mgr:standalone-application:list](#runtime-mgr-standalone-application-list).

In addition to the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--insight</code></p></div></div></td><td><div><div><p>Stores message metadata of every Mule transaction.</p></div></div></td><td><div><div><p><code>--insight</code></p></div></div></td></tr><tr><td><div><div><p><code>--log [level:scope]</code></p></div></div></td><td><div><div><p>Sets the logging level and scope pair:</p></div><div><ul><li><p><code>level</code>: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF</p></li><li><p><code>scope</code>: package name of the class, connector, or module to log, such as <code>org.mule.extension.ftp</code> for Anypoint Connector for FTP</p></li></ul></div><div><p>To set multiple logging levels, provide multiple <code>--log</code> flags.</p></div></div></td><td><div><div><p><code>--log INFO:org.apache --log WARN:org.mule</code></p></div></div></td></tr></tbody></table>

## runtime-mgr:standalone-application:restart

\> runtime-mgr:standalone-application:restart \[flags\] <identifier>

Restarts the standalone (on-premises) application passed in `identifier`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:standalone-application:start

\> runtime-mgr:standalone-application:start \[flags\] <identifier>

Starts the standalone (on-premises) application passed in `identifier`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

## runtime-mgr:standalone-application:stop

\> runtime-mgr:standalone-application:stop \[flags\] <identifier>

Stops the standalone (on-premises) application passed in `identifier`.

This command accepts the [default flags](https://docs.mulesoft.com/anypoint-cli/latest/#default-options).

<!-- document id=77c466d08fc32f8ba103fb0f6256286eaca6bade341fa964ada9bc3bf1c39af9 url=/mulesoft/current/en-us/anypoint-cli/latest/troubleshooting.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Troubleshooting Anypoint CLI

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

If you encounter errors when attempting to run Anypoint CLI commands, troubleshoot them as follows.

## Before You Begin Troubleshooting

Ensure you’re using the latest version of `anypoint-cli-v4`. If not, install the latest version
before continuing. See [Install Anypoint CLI 4.x](https://docs.mulesoft.com/anypoint-cli/latest/install).

## Status Code 409 Error When Uploading

The error `Request failed with status code 409` when using the `exchange asset upload` command to
publish a ruleset might occur when you’re attempting to upload a duplicate asset.

To resolve this issue:

- Change the command to specify a unique ruleset asset identifier by doing one of the following:

  - Publish a new version of the ruleset by changing the version part of the asset identifier. For
    example, change `1.0.0` to `1.0.1`.

    Here is an example updated command:

    anypoint-cli-v4 exchange asset upload my-auth-best-practices/1.0.1 --name "My Best Practices
    Ruleset" --description "This ruleset enforces my best practices for APIs."
    --files='{"ruleset.yaml":"/myRulesetFolder/mynewruleset.yaml","docs.zip":"/myRulesetFolder/ruleset.doc.zip"}'

  - Publish a new asset by changing the asset ID part of the asset identifier. For example, change
    `my-auth-best-practices` to `my-new-auth-best-practices`.

    Here is an example updated command:

    anypoint-cli-v4 exchange asset upload my-new-auth-best-practices/1.0.0 --name "My Best Practices
    Ruleset" --description "This ruleset enforces my best practices for APIs."
    --files='{"ruleset.yaml":"/myRulesetFolder/mynewruleset.yaml","docs.zip":"/myRulesetFolder/ruleset.doc.zip"}'

## Error Determining Asset Type

The error `Could not determine asset type, step: Publishing asset` when using the
`exchange asset upload` command to publish a ruleset or other asset might occur when you:

- Specify a `--type` flag and more than one file type in one or more `--files` flags.

  If you’re uploading multiple files, omit the `--type` flag to let Anypoint CLI infer the correct
  file type from the `classifier.packaging` in each `--files` flag.

- Specify a `--type` flag that conflicts with the asset type Anypoint CLI infers.

  Verify that the `classifier.packaging` and file name values in your `--files` flag options are
  correct and that they match the asset type you specified in the `--type` flag.

- Include properties in `exchange.json` or `--properties` that are incorrect.

  The `exchange.json` file is optional when uploading an asset because the CLI includes or infers
  required properties from parameters, flags, and options. If you download a ruleset project to base
  your custom ruleset on, do one of the following before uploading your custom ruleset:

  - Remove the `exchange.json` file from your working folder or project.

  - Update the properties in the `exchange.json` file to match your custom ruleset’s asset ID, name,
    main file, and so on.

## Unable to Publish

A non-specific publishing error similar to `unable to publish` might occur when you use the
`exchange asset upload` command to upload your custom ruleset and its documentation.

If you attempt to upload an asset using the wrong command syntax, you might inadvertently publish it
as the wrong asset type. You can’t republish the asset with the same asset ID as a different asset
type.

To republish the ruleset in this situation, fix the syntax, change the asset ID, and try uploading
again. For example, change `my-auth-best-practices` to `my-new auth-best-practices`.

Here is an example updated command:

anypoint-cli-v4 exchange asset upload my-new-auth-best-practices/1.0.0 --name "My Best Practices
Ruleset" --description "This ruleset enforces my best practices for APIs."
--files='{"ruleset.yaml":"/myRulesetFolder/mynewruleset.yaml","docs.zip":"/myRulesetFolder/ruleset.doc.zip"}'

## Miscellaneous Errors

Anypoint CLI parses commands for specific information, and if the CLI doesn’t recognize or correctly
interpret the command, the error message might be misleading or vague. To troubleshoot these errors:

- Ensure that you’re entering the command flags and options as documented.

- Ensure that you have specified everything in the command using the proper case, including the
  command itself, flags, classifiers, options, folder names, and file names. Commands are
  case-sensitive.

- Ensure that there are no curly, or smart, quotation marks in your command. Replace any curly
  quotation marks with straight quotation marks (`'` or `"`).

- Ensure that you’re entering your information in option values. You can’t run most command examples
  verbatim. You must use your values for parameters and options, including organization ID,
  environment ID, host ID, asset identifier GAV (group ID/asset ID/version), and folder and file
  names.

- Ensure that you’re specifying the proper folders for files in the command or that you have changed
  to the working directory where they’re located.

- Search the [Salesforce Help](https://help.salesforce.com) for similar errors.

## Windows Command Syntax

Some commands that include special characters like backslashes `\` or pipes `|` don’t behave as
expected on Windows systems because Windows Command Prompt interprets these characters in a
different way.

\+ To use the commands successfully: \* For file paths, replace single backslashes (`\`) with double
backslashes (`\\`). \* To use pipes (`|`) in commands, add a caret (`^`) before them.

Example:

Original command:

api-mgr:policy:apply --config '{\\"username\\":\\"user\\",\\"password\\":\\"test\\"}'

Modified command for Windows:

api-mgr:policy:apply --config
'{\\\\"username\\\\":\\\\"user\\\\",\\\\"password\\\\":\\\\"test\\\\"}'

Escape the JSON text using the backslash character (`\`). For example, change `"` and `/` to `\"`
and `\/`.

Here is an example updated command:

anypoint-cli-v4 exchange asset upload my-auth-best-practices/1.0.0 --name "My Best Practices
Ruleset" --description "This ruleset enforces my best practices for APIs."
--files='{\\"ruleset.yaml\\":\\"\\/myRulesetFolder\\/mynewruleset.yaml\\",\\"docs.zip\\":\\"\\/myRulesetFolder\\/ruleset.doc.zip\\"}'

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=7a478c4a58e75963c1784b1de4d92a98d1a68ace079ccf42b2d55f8db473ce61 url=/mulesoft/current/en-us/anypoint-cli/3.x/intro.md -->

---
product: Anypoint CLI
version: 3.x
---

# Use Anypoint CLI

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

An Anypoint Platform CLI call has the following form:

```console
$ anypoint-cli [params] [command]
```

## exit

\> exit \[options\]

This command exits Anypoint Platform CLI.

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

If you choose not to pass a command, Anypoint Platform CLI runs in interactive mode. If you choose
to pass a specific command and there is an error, the application exits and returns a description of
the issue.

The Anypoint Platform CLI provides three default options:

- The `--help` option displays usage information of the command.

- The `-o` or `--output` option lets you specify the command’s output to the defined format.  
  Supported values are `table`, `text`, and `json`. Defaults to `text` for non-interactive mode and
  `table` for interactive sessions.

- The `-f` or `--fields` option allows you to define which fields to output.  
  You can pass the `--fields` option after a command to get a list of all possible fields to output.

<!-- document id=e5721eeb6aec272f9f24e3546960029d008a274594cd835d050ebaa69b6a68dc url=/mulesoft/current/en-us/anypoint-cli/latest/proxy.md -->

---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Using Anypoint CLI with a Network Proxy

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

Anypoint CLI can be run through a network proxy to add a layer of security. To use the Anypoint CLI
with a proxy server, configure the `HTTP_PROXY` or `HTTPS_PROXY` environment variables with the
hostname or IP addresses of your proxy servers as shown in the following sections. Use the
`ANYPOINT_CERTIFICATE` variable to configure your trusted certificates required by proxy.

## Configure a Proxy Server Without Authentication

To configure a proxy server that does not require authentication, use the following commands:

- Linux, macOS, or Unix

  `$ export HTTP_PROXY=http://_proxy-server_:80`

  or

  `$ export HTTPS_PROXY=https://_proxy-server_:443`

- Windows

  `> set HTTP_PROXY=http://_proxy-server_:80`

  or

  `> set HTTPS_PROXY=https//_proxy-server_:443`

## Configure a Proxy Server With Authentication

To configure a proxy server that requires authentication, use these commands:

- Linux, macOS, or Unix

  `$ export HTTP_PROXY=http://_username_:_password_@_proxy-server_:80`

  or

  `$ export HTTPS_PROXY=https://_username_:_password_@_proxy-server_:443`

- Windows

  `> set HTTP_PROXY=http://_username_:_password_@_proxy-server_:80`

  or

  `> set HTTPS_PROXY=https://_username_:_password_@_proxy-server_:443`