Anypoint CLI 4.x List of Commands

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

Anypoint Platform Accounts
Agent Fabric
API Catalog
API Governance
API Manager
Cloudhub 2.0
Cloudhub Apps
Cloudhub Dedicated Load Balancers
Cloudhub Anypoint VPCs
Datagraph Load Balancer
Design Center
Exchange Assets
Hybrid Applications
Alerts for Hybrid Applications
Local Servers
Local Server Groups
Local Server Clusters

Anypoint Platform Accounts

Command	Description
account:business-group:describe	Show details of a business group
account:business-group:list	Lists business groups
account:environment:create	Create new environment
account:environment:delete	Delete an environment
account:environment:describe	Shows details of an environment
account:environment:list	Lists environments
account:user:describe	Show account details

Command

Description

account:business-group:describe

Show details of a business group

account:business-group:list

Lists business groups

account:environment:create

Create new environment

account:environment:delete

Delete an environment

account:environment:describe

Shows details of an environment

account:environment:list

Lists environments

account:user:describe

Show account details

Agent Fabric

Command	Description
agent-network:project:build	Builds the agent network project and validates configuration
agent-network:project:create	Creates a new agent network project and generates the initial configuration files
agent-network:project:deploy	Deploys the agent network project to the target environment
agent-network:project:publish	Publishes the agent network project to Anypoint Exchange
agent-network:setup:gateways	Sets up the gateways for the agent network

Command

Description

agent-network:project:build

Builds the agent network project and validates configuration

agent-network:project:create

Creates a new agent network project and generates the initial configuration files

agent-network:project:deploy

Deploys the agent network project to the target environment

agent-network:project:publish

Publishes the agent network project to Anypoint Exchange

agent-network:setup:gateways

Sets up the gateways for the agent network

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, this command accepts these flags:

Flag Description Example

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

--bearer <value>

Bearer token
You can also set it with ANYPOINT_BEARER env variable

--bearer myBearerToken

--client_id <value>

Client ID
You can also set it with the ANYPOINT_CLIENT_ID env variable

--client_id myClientID

--client_secret <value>

Client Secret
You can also set it with the ANYPOINT_CLIENT_SECRET env variable

--client_secret myClientSecret

--[no-]collectMetrics

Collect metrics
You can also set it with the COLLECT_METRICS env variable

--no-collectMetrics

--debug

Enable debug mode

--debug

--environment <value>

Environment name
You can also set it with the ANYPOINT_ENV variable

--environment Sandbox

--forceUpdate

Force update the dependencies

--forceUpdate

--host <value>

Host URL
Default: anypoint.mulesoft.com
You can also set it with the ANYPOINT_HOST variable

--host mycompany.anypoint.mulesoft.com

--organization <value>

Organization name
You can also set it with the ANYPOINT_ORG variable

--organization MyOrg

--password <value>

Password
You can also set it with the ANYPOINT_PASSWORD variable

--password myPassword

--path <value>

Path to the project
Default: .

--path ./my-agent-network

--username <value>

Username
You can also set it with the ANYPOINT_USERNAME variable

--username myuser@example.com

$ 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, this command accepts these flags:

Flag Description Example

Flag	Description	Example
`-n, --name <value>`	(Required) Name of the project	`--name my-agent-network`
`-o, --output-dir <value>`	Output directory for the project	`--output-dir ./projects`
`--asset-id <value>`	Asset ID (GAV)	`--asset-id my-asset`
`--asset-version <value>`	Asset version (GAV) Default: `1.0.0`	`--asset-version 1.2.0`
`--bearer <value>`	Bearer token You can also set it with the `ANYPOINT_BEARER` variable	`--bearer myBearerToken`
`--client_id <value>`	Client ID You can also set it with the `ANYPOINT_CLIENT_ID` variable	`--client_id myClientID`
`--client_secret <value>`	Client Secret You can also set it with the `ANYPOINT_CLIENT_SECRET` variable	`--client_secret myClientSecret`
`--[no-]collectMetrics`	Collect metrics You can also set it with the `COLLECT_METRICS` variable	`--no-collectMetrics`
`--[no-]create-dir`	Create a new directory under `output-dir` using the project name	`--create-dir`
`--environment <value>`	Environment name You can also set it with the `ANYPOINT_ENV` variable	`--environment Sandbox`
`--group-id <value>`	Group ID (GAV)	`--group-id com.myorg`
`--host <value>`	Host URL Default: `anypoint.mulesoft.com` You can also set it with the `ANYPOINT_HOST` variable	`--host mycompany.anypoint.mulesoft.com`
`--organization <value>`	Organization name You can also set it with the `ANYPOINT_ORG` env variable	`--organization MyOrg`
`--password <value>`	Password You can also set it with the `ANYPOINT_PASSWORD` variable	`--password myPassword`
`--tab-size <value>`	Tab size for indenting the API specification Default: `2`	`--tab-size 4`
`--username <value>`	Username You can also set it with the `ANYPOINT_USERNAME` variable	`--username myuser@example.com`

-n, --name <value>

(Required) Name of the project

--name my-agent-network

-o, --output-dir <value>

Output directory for the project

--output-dir ./projects

--asset-id <value>

Asset ID (GAV)

--asset-id my-asset

--asset-version <value>

Asset version (GAV)
Default: 1.0.0

--asset-version 1.2.0

--bearer <value>

Bearer token
You can also set it with the ANYPOINT_BEARER variable

--bearer myBearerToken

--client_id <value>

Client ID
You can also set it with the ANYPOINT_CLIENT_ID variable

--client_id myClientID

--client_secret <value>

Client Secret
You can also set it with the ANYPOINT_CLIENT_SECRET variable

--client_secret myClientSecret

--[no-]collectMetrics

Collect metrics
You can also set it with the COLLECT_METRICS variable

--no-collectMetrics

--[no-]create-dir

Create a new directory under output-dir using the project name

--create-dir

--environment <value>

Environment name
You can also set it with the ANYPOINT_ENV variable

--environment Sandbox

--group-id <value>

Group ID (GAV)

--group-id com.myorg

--host <value>

Host URL
Default: anypoint.mulesoft.com
You can also set it with the ANYPOINT_HOST variable

--host mycompany.anypoint.mulesoft.com

--organization <value>

Organization name
You can also set it with the ANYPOINT_ORG env variable

--organization MyOrg

--password <value>

Password
You can also set it with the ANYPOINT_PASSWORD variable

--password myPassword

--tab-size <value>

Tab size for indenting the API specification
Default: 2

--tab-size 4

--username <value>

Username
You can also set it with the ANYPOINT_USERNAME variable

--username myuser@example.com

$ 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 to the target private space. By default, the command uses the agent-network-ingress-gw and agent-network-egress-gw gateways, and the agent-network-space private space. You can override these values using flags.

In addition to the default flags, this command accepts these flags:

Flag Description Example

Flag	Description	Example
`-e, --egress-gw <value>`	Name of the target egress gateway Default: `agent-network-egress-gw`	`--egress-gw custom-egress`
`-i, --ingress-gw <value>`	Name of the target ingress gateway Default: `agent-network-ingress-gw`	`--ingress-gw custom-ingress`
`-t, --target-space <value>`	Name of the target private space to deploy Default: `agent-network-space`	`--target-space my-space`
`--bearer <value>`	Bearer token You can also set it with the `ANYPOINT_BEARER` variable	`--bearer myBearerToken`
`--client_id <value>`	Client ID You can also set it with the `ANYPOINT_CLIENT_ID` variable	`--client_id myClientID`
`--client_secret <value>`	Client Secret You can also set it with the `ANYPOINT_CLIENT_SECRET` variable	`--client_secret myClientSecret`
`--[no-]collectMetrics`	Collect metrics You can also set it with the `COLLECT_METRICS` variable	`--no-collectMetrics`
`--disable-tracing`	Disable tracing functionalities	`--disable-tracing`
`--dont-wait-for-agent-network`	Do not wait for the agent network to be ready	`--dont-wait-for-agent-network`
`--environment <value>`	Environment name You can also set it with the `ANYPOINT_ENV` variable	`--environment Sandbox`
`--host <value>`	Host URL Default: `anypoint.mulesoft.com` You can also set it with the `ANYPOINT_HOST` variable	`--host mycompany.anypoint.mulesoft.com`
`--organization <value>`	Organization name You can also set it with the `ANYPOINT_ORG` variable	`--organization MyOrg`
`--password <value>`	Password You can also set it with the `ANYPOINT_PASSWORD` variable	`--password myPassword`
`--path <value>`	Path to the project Default: `.`	`--path ./my-agent-network`
`--property <value>`	One or more deployment properties in `name:value` format	`--property logLevel:DEBUG`
`--username <value>`	Username You can also set it with the `ANYPOINT_USERNAME` variable	`--username myuser@example.com`
`--json`	Format output as JSON	`--json`

-e, --egress-gw <value>

Name of the target egress gateway
Default: agent-network-egress-gw

--egress-gw custom-egress

-i, --ingress-gw <value>

Name of the target ingress gateway
Default: agent-network-ingress-gw

--ingress-gw custom-ingress

-t, --target-space <value>

Name of the target private space to deploy
Default: agent-network-space

--target-space my-space

--bearer <value>

Bearer token
You can also set it with the ANYPOINT_BEARER variable

--bearer myBearerToken

--client_id <value>

Client ID
You can also set it with the ANYPOINT_CLIENT_ID variable

--client_id myClientID

--client_secret <value>

Client Secret
You can also set it with the ANYPOINT_CLIENT_SECRET variable

--client_secret myClientSecret

--[no-]collectMetrics

Collect metrics
You can also set it with the COLLECT_METRICS variable

--no-collectMetrics

--disable-tracing

Disable tracing functionalities

--disable-tracing

--dont-wait-for-agent-network

Do not wait for the agent network to be ready

--dont-wait-for-agent-network

--environment <value>

Environment name
You can also set it with the ANYPOINT_ENV variable

--environment Sandbox

--host <value>

Host URL
Default: anypoint.mulesoft.com
You can also set it with the ANYPOINT_HOST variable

--host mycompany.anypoint.mulesoft.com

--organization <value>

Organization name
You can also set it with the ANYPOINT_ORG variable

--organization MyOrg

--password <value>

Password
You can also set it with the ANYPOINT_PASSWORD variable

--password myPassword

--path <value>

Path to the project
Default: .

--path ./my-agent-network

--property <value>

One or more deployment properties in name:value format

--property logLevel:DEBUG

--username <value>

Username
You can also set it with the ANYPOINT_USERNAME variable

--username myuser@example.com

--json

Format output as JSON

--json

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

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, this command accepts these flags:

Flag Description Example

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

--bearer <value>

Bearer token
You can also set it with the ANYPOINT_BEARER variable

--bearer myBearerToken

--client_id <value>

Client ID
You can also set it with the ANYPOINT_CLIENT_ID variable

--client_id myClientID

--client_secret <value>

Client Secret
You can also set it with the ANYPOINT_CLIENT_SECRET variable

--client_secret myClientSecret

--[no-]collectMetrics

Collect metrics
You can also set it with the COLLECT_METRICS variable

--no-collectMetrics

--debug

Enable debug mode

--debug

--environment <value>

Environment name
You can also set it with the ANYPOINT_ENV variable

--environment Sandbox

--host <value>

Host URL
Default: anypoint.mulesoft.com
You can also set it with the ANYPOINT_HOST variable

--host mycompany.anypoint.mulesoft.com

--organization <value>

Organization name
You can also set it with ANYPOINT_ORG env variable

--organization MyOrg

--password <value>

Password
You can also set it with the ANYPOINT_PASSWORD variable

--password myPassword

--path <value>

Path to the project
Default: .

--path ./my-agent-network

--username <value>

Username
You can also set it with the ANYPOINT_USERNAME variable

--username myuser@example.com

--json

Format output as JSON

--json

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

agent-network:setup:gateways

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

Sets up the agent network environment with the required ingress and egress gateways in the specified target private space. This step is required only if the target space does not 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, this command accepts these flags:

Flag Description Example

Flag	Description	Example
`-e, --egress-gw <value>`	Name of the egress gateway Default: `agent-network-egress-gw`	`--egress-gw my-egress`
`-i, --ingress-gw <value>`	Name of the ingress gateway Default: `agent-network-ingress-gw`	`--ingress-gw my-ingress`
`-t, --target-space <value>`	Name of the target private space where the gateways will be set up Default: `agent-network-space`	`--target-space my-space`
`--bearer <value>`	Bearer token You can also set it with the `ANYPOINT_BEARER` variable	`--bearer myBearerToken`
`--client_id <value>`	Client ID You can also set it with the`ANYPOINT_CLIENT_ID` variable	`--client_id myClientID`
`--client_secret <value>`	Client Secret You can also set it with the`ANYPOINT_CLIENT_SECRET` variable	`--client_secret myClientSecret`
`--[no-]collectMetrics`	Collect metrics You can also set it with the`COLLECT_METRICS` variable	`--no-collectMetrics`
`--environment <value>`	Environment name You can also set it with the `ANYPOINT_ENV` variable	`--environment Sandbox`
`--host <value>`	Host URL Default: `anypoint.mulesoft.com` You can also set it with the `ANYPOINT_HOST` variable	`--host mycompany.anypoint.mulesoft.com`
`--organization <value>`	Organization name You can also set it with the `ANYPOINT_ORG` variable	`--organization MyOrg`
`--password <value>`	Password You can also set it with the `ANYPOINT_PASSWORD` variable	`--password myPassword`
`--username <value>`	Username You can also set it with the `ANYPOINT_USERNAME` variable	`--username myuser@example.com`

-e, --egress-gw <value>

Name of the egress gateway
Default: agent-network-egress-gw

--egress-gw my-egress

-i, --ingress-gw <value>

Name of the ingress gateway
Default: agent-network-ingress-gw

--ingress-gw my-ingress

-t, --target-space <value>

Name of the target private space where the gateways will be set up
Default: agent-network-space

--target-space my-space

--bearer <value>

Bearer token
You can also set it with the ANYPOINT_BEARER variable

--bearer myBearerToken

--client_id <value>

Client ID
You can also set it with the`ANYPOINT_CLIENT_ID` variable

--client_id myClientID

--client_secret <value>

Client Secret
You can also set it with the`ANYPOINT_CLIENT_SECRET` variable

--client_secret myClientSecret

--[no-]collectMetrics

Collect metrics
You can also set it with the`COLLECT_METRICS` variable

--no-collectMetrics

--environment <value>

Environment name
You can also set it with the ANYPOINT_ENV variable

--environment Sandbox

--host <value>

Host URL
Default: anypoint.mulesoft.com
You can also set it with the ANYPOINT_HOST variable

--host mycompany.anypoint.mulesoft.com

--organization <value>

Organization name
You can also set it with the ANYPOINT_ORG variable

--organization MyOrg

--password <value>

Password
You can also set it with the ANYPOINT_PASSWORD variable

--password myPassword

--username <value>

Username
You can also set it with the ANYPOINT_USERNAME variable

--username myuser@example.com

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

API Catalog

Command	Description
api-catalog autocomplete	Configures autocompletion for API Catalog commands
api-catalog conf	Creates or deletes a credentials configuration file
api-catalog create-descriptor	Creates a descriptor file
api-catalog update-descriptor	Updates a descriptor file
api-catalog publish-asset	Publishes assets to Exchange

Command

Description

api-catalog autocomplete

Configures autocompletion for API Catalog commands

api-catalog conf

Creates or deletes a credentials configuration file

api-catalog create-descriptor

Creates a descriptor file

api-catalog update-descriptor

Updates a descriptor file

api-catalog publish-asset

Publishes assets to Exchange

API Governance

Command

Description

governance:api:evaluate

Evaluates filter criteria to determine which rulesets apply to APIs that meet that criteria

governance:api:inspect

Inspects an API specification and lists its schemas

governance:api:validate

Validates an API specification against a specified governance ruleset

governance:document

Creates the documentation file for a governance ruleset definition

governance:profile:create

Creates an active governance profile

governance:profile:delete

Deletes a governance profile

governance:profile:info

Lists information for a specific governance profile ID

governance:profile:list

Lists all governance profiles for an organization

governance:profile:update

Updates a governance profile

governance:ruleset:clone

Clones a governance ruleset and applies specified updates to rules

governance:ruleset:info

Lists ruleset rules

governance:ruleset:init

Initializes a governance ruleset definition based on a data schema

governance:ruleset:validate

Validates a governance ruleset definition’s format

API Manager

Command	Description
api-mgr:alert:add	Creates an API instance alert
api-mgr:alert:list	Lists alerts for an API instance
api-mgr:api:autodiscovery	Lists the autodiscovery properties
api-mgr:api:change-specification	Changes the asset version for an API instance by choosing a new version from Exchange
api-mgr:api:classify	Classifies an API instance in a given environment
api-mgr:api:delete	Deletes an API
api-mgr:api:deploy	Deploys an API to CloudHub, CloudHub2, Hybrid Server, or Runtime Fabric
api-mgr:api:deprecate	Deprecates an API instance
api-mgr:api:describe	Shows details of an API
api-mgr:api:download-proxy	Downloads the API proxy ZIP file to a local directory
api-mgr:api:edit	Edits an API instance
api-mgr:api:list	Lists all APIs in API Manager 2.x
api-mgr:api:manage	Manages a new API, API version, or new API instance with an asset from Exchange
api-mgr:api:promote	Promotes an API instance from source environment
api-mgr:api:redeploy	Redeploys an API to CloudHub, CloudHub2, Hybrid Server, or Runtime Fabric
api-mgr:api:undeprecate	Undeprecates an API instance
api-mgr:contract:delete	Deletes a given API contract
api-mgr:contract:list	Lists all contracts to a given API instance
api-mgr:policy:apply	Applies a policy to a given API instance
api-mgr:policy:describe	Shows the description and available configuration properties of a given policy template
api-mgr:policy:disable	Disables policy from a given API instance
api-mgr:policy:edit	Edits the policy configuration of a given API instance
api-mgr:policy:enable	Enables a policy on a given API instance
api-mgr:policy:list	Lists policies
api-mgr:policy:remove	Removes a policy from a given API instance
api-mgr:tier:add	Creates an SLA tier
api-mgr:tier:copy	Copies an SLA tier from source to a target API instance
api-mgr:tier:delete	Deletes an SLA tier from an API instance
api-mgr:tier:list	Lists the SLA tiers of an API instance

Command

Description

api-mgr:alert:add

Creates an API instance alert

api-mgr:alert:list

Lists alerts for an API instance

api-mgr:api:autodiscovery

Lists the autodiscovery properties

api-mgr:api:change-specification

Changes the asset version for an API instance by choosing a new version from Exchange

api-mgr:api:classify

Classifies an API instance in a given environment

api-mgr:api:delete

Deletes an API

api-mgr:api:deploy

Deploys an API to CloudHub, CloudHub2, Hybrid Server, or Runtime Fabric

api-mgr:api:deprecate

Deprecates an API instance

api-mgr:api:describe

Shows details of an API

api-mgr:api:download-proxy

Downloads the API proxy ZIP file to a local directory

api-mgr:api:edit

Edits an API instance

api-mgr:api:list

Lists all APIs in API Manager 2.x

api-mgr:api:manage

Manages a new API, API version, or new API instance with an asset from Exchange

api-mgr:api:promote

Promotes an API instance from source environment

api-mgr:api:redeploy

Redeploys an API to CloudHub, CloudHub2, Hybrid Server, or Runtime Fabric

api-mgr:api:undeprecate

Undeprecates an API instance

api-mgr:contract:delete

Deletes a given API contract

api-mgr:contract:list

Lists all contracts to a given API instance

api-mgr:policy:apply

Applies a policy to a given API instance

api-mgr:policy:describe

Shows the description and available configuration properties of a given policy template

api-mgr:policy:disable

Disables policy from a given API instance

api-mgr:policy:edit

Edits the policy configuration of a given API instance

api-mgr:policy:enable

Enables a policy on a given API instance

api-mgr:policy:list

Lists policies

api-mgr:policy:remove

Removes a policy from a given API instance

api-mgr:tier:add

Creates an SLA tier

api-mgr:tier:copy

Copies an SLA tier from source to a target API instance

api-mgr:tier:delete

Deletes an SLA tier from an API instance

api-mgr:tier:list

Lists the SLA tiers of an API instance

Cloudhub 2.0

Command	Description
runtime-mgr:application:delete	Deletes an application
runtime-mgr:application:describe	Describes an application
runtime-mgr:application:deploy	Deploys an application to a specified target using an Exchange application and runs the specified runtime version
runtime-mgr:application:download:logs	Downloads logs of an application from a specification to a specified directory
runtime-mgr:application:list	Lists all applications in an organization
runtime-mgr:application:modify	Modifies a deployed application
runtime-mgr:application:start	Starts a stopped application
runtime-mgr:application:stop	Stops running an application
runtime-mgr:application:logs	Tails an application’s logs from a specification

Command

Description

runtime-mgr:application:delete

Deletes an application

runtime-mgr:application:describe

Describes an application

runtime-mgr:application:deploy

Deploys an application to a specified target using an Exchange application and runs the specified runtime version

runtime-mgr:application:download:logs

Downloads logs of an application from a specification to a specified directory

runtime-mgr:application:list

Lists all applications in an organization

runtime-mgr:application:modify

Modifies a deployed application

runtime-mgr:application:start

Starts a stopped application

runtime-mgr:application:stop

Stops running an application

runtime-mgr:application:logs

Tails an application’s logs from a specification

Cloudhub Apps

Command	Description
runtime-mgr:cloudhub-alert-history:describe	Describes the history of the alarm
runtime-mgr:cloudhub-alert:list	Lists all alerts in the environment
runtime-mgr:cloudhub-application:copy	Copies a CloudHub application
runtime-mgr:cloudhub:application:delete	Deletes an application
runtime-mgr:cloudhub-application:deploy	Deploys a new application
runtime-mgr:cloudhub-application:describe	Shows application details
runtime-mgr:cloudhub-application:download:logs	Download application logs to specified directory
runtime-mgr:cloudhub:application:list	Lists all applications in the environment
runtime-mgr:cloudhub-application:modify	Modifies an existing application, optionally updating the ZIP file
runtime-mgr:cloudhub-application:restart	Restarts a running application
runtime-mgr:cloudhub-application:start	Starts an application
runtime-mgr:cloudhub-application:stop	Stops a running application
runtime-mgr:cloudhub-application:tail:logs	Tail application logs
cloudhub:region:list	Lists all supported regions
cloudhub:runtime:list	Lists all available runtimes

Command

Description

runtime-mgr:cloudhub-alert-history:describe

Describes the history of the alarm

runtime-mgr:cloudhub-alert:list

Lists all alerts in the environment

runtime-mgr:cloudhub-application:copy

Copies a CloudHub application

runtime-mgr:cloudhub:application:delete

Deletes an application

runtime-mgr:cloudhub-application:deploy

Deploys a new application

runtime-mgr:cloudhub-application:describe

Shows application details

runtime-mgr:cloudhub-application:download:logs

Download application logs to specified directory

runtime-mgr:cloudhub:application:list

Lists all applications in the environment

runtime-mgr:cloudhub-application:modify

Modifies an existing application, optionally updating the ZIP file

runtime-mgr:cloudhub-application:restart

Restarts a running application

runtime-mgr:cloudhub-application:start

Starts an application

runtime-mgr:cloudhub-application:stop

Stops a running application

runtime-mgr:cloudhub-application:tail:logs

Tail application logs

cloudhub:region:list

Lists all supported regions

cloudhub:runtime:list

Lists all available runtimes

Cloudhub Dedicated Load Balancers

Command	Description
cloudhub:load-balancer:allowlist:add	Adds an IP or range of IPs to the load balancer allowlist
cloudhub:load-balancer:allowlist:remove	Removes an IP or range of IPs from the load balancer allowlist
cloudhub:load-balancer:create	Creates a load balancer
cloudhub:load-balancer:delete	Deletes a load balancer
cloudhub:load-balancer:describe	Shows load balancer details
cloudhub:load-balancer:dynamic-ips:disable	Disables dynamic IPs
cloudhub:load-balancer:dynamic-ips:enable	Enables dynamic IPs
cloudhub:load-balancer:list	Lists all load balancers in an organization
cloudhub:load-balancer:mappings:add	Adds a proxy mapping rule at the specified index
cloudhub:load-balancer:mappings:describe	Lists the proxy mapping rules for a load balancer
cloudhub:load-balancer:mappings:remove	Removes a proxy mapping rule
cloudhub:load-balancer:ssl-endpoint:add	Adds an additional certificate to an existing load balancer
cloudhub:load-balancer:ssl-endpoint:describe	Shows the load balancer configuration for a particular certificate
cloudhub:load-balancer:ssl-endpoint:remove	Removes a certificate from a load balancer
cloudhub:load-balancer:ssl-endpoint:set-default	Sets the default certificate that the load balancer will serve
cloudhub:load-balancer:start	Starts a load balancer
cloudhub:load-balancer:stop	Stops a load balancer

Command

Description

cloudhub:load-balancer:allowlist:add

Adds an IP or range of IPs to the load balancer allowlist

cloudhub:load-balancer:allowlist:remove

Removes an IP or range of IPs from the load balancer allowlist

cloudhub:load-balancer:create

Creates a load balancer

cloudhub:load-balancer:delete

Deletes a load balancer

cloudhub:load-balancer:describe

Shows load balancer details

cloudhub:load-balancer:dynamic-ips:disable

Disables dynamic IPs

cloudhub:load-balancer:dynamic-ips:enable

Enables dynamic IPs

cloudhub:load-balancer:list

Lists all load balancers in an organization

cloudhub:load-balancer:mappings:add

Adds a proxy mapping rule at the specified index

cloudhub:load-balancer:mappings:describe

Lists the proxy mapping rules for a load balancer

cloudhub:load-balancer:mappings:remove

Removes a proxy mapping rule

cloudhub:load-balancer:ssl-endpoint:add

Adds an additional certificate to an existing load balancer

cloudhub:load-balancer:ssl-endpoint:describe

Shows the load balancer configuration for a particular certificate

cloudhub:load-balancer:ssl-endpoint:remove

Removes a certificate from a load balancer

cloudhub:load-balancer:ssl-endpoint:set-default

Sets the default certificate that the load balancer will serve

cloudhub:load-balancer:start

Starts a load balancer

cloudhub:load-balancer:stop

Stops a load balancer

Cloudhub Anypoint VPCs

Command	Description
cloudhub:vpc:business-groups:add	Shares an Anypoint VPC with a list of Business Groups
cloudhub:vpc:business-groups:remove	Shares an Anypoint VPC with a list of Business Groups
cloudhub:vpc:create	Creates a new Anypoint VPC
cloudhub:vpc:delete	Deletes an existing Anypoint VPC
cloudhub:vpc:describe	Show Anypoint VPC details
cloudhub:vpc:dns-servers:set	Sets the domain names that are resolved using your internal DNS servers
cloudhub:vpc:dns-servers:unset	Clears the list domain names that are resolved using your internal DNS servers
cloudhub:vpc:environments:add	Modifies the Anypoint VPC association to Runtime Manager environments
cloudhub:vpc:environments:remove	Modifies the Anypoint VPC association to Runtime Manager environments
cloudhub:vpc:firewall-rules:add	Adds a firewall rule for Mule applications in this Anypoint VPC
cloudhub:vpc:firewall-rules:describe	Shows firewall rule for Mule applications in this Anypoint VPC
cloudhub:vpc:firewall-rules:remove	Removes a firewall rule for Mule applications in this Anypoint VPC
cloudhub:vpc:list	Lists all Anypoint VPCs

Command

Description

cloudhub:vpc:business-groups:add

Shares an Anypoint VPC with a list of Business Groups

cloudhub:vpc:business-groups:remove

Shares an Anypoint VPC with a list of Business Groups

cloudhub:vpc:create

Creates a new Anypoint VPC

cloudhub:vpc:delete

Deletes an existing Anypoint VPC

cloudhub:vpc:describe

Show Anypoint VPC details

cloudhub:vpc:dns-servers:set

Sets the domain names that are resolved using your internal DNS servers

cloudhub:vpc:dns-servers:unset

Clears the list domain names that are resolved using your internal DNS servers

cloudhub:vpc:environments:add

Modifies the Anypoint VPC association to Runtime Manager environments

cloudhub:vpc:environments:remove

Modifies the Anypoint VPC association to Runtime Manager environments

cloudhub:vpc:firewall-rules:add

Adds a firewall rule for Mule applications in this Anypoint VPC

cloudhub:vpc:firewall-rules:describe

Shows firewall rule for Mule applications in this Anypoint VPC

cloudhub:vpc:firewall-rules:remove

Removes a firewall rule for Mule applications in this Anypoint VPC

cloudhub:vpc:list

Lists all Anypoint VPCs

Datagraph Load Balancer

Command	Description
datagraph:load-balancer-config:add	Adds a dedicated load balancer configuration to Anypoint DataGraph
datagraph:load-balancer-config:describe	Displays a dedicated load balancer configuration for Anypoint DataGraph
datagraph:load-balancer-config:remove	Removes a dedicated load balancer configuration from Anypoint DataGraph

Command

Description

datagraph:load-balancer-config:add

Adds a dedicated load balancer configuration to Anypoint DataGraph

datagraph:load-balancer-config:describe

Displays a dedicated load balancer configuration for Anypoint DataGraph

datagraph:load-balancer-config:remove

Removes a dedicated load balancer configuration from Anypoint DataGraph

Design Center

Command	Description
designcenter:project:create	Creates a new Design Center project
designcenter:project:delete	Deletes a Design Center project
designcenter:project:download	Downloads the content of a Design Center project
designcenter:project:list	Lists all Design Center projects
designcenter:project:publish	Publishes a Design Center project to Exchange
designcenter:project:upload	Uploads the content of a project to Design Center

Command

Description

designcenter:project:create

Creates a new Design Center project

designcenter:project:delete

Deletes a Design Center project

designcenter:project:download

Downloads the content of a Design Center project

designcenter:project:list

Lists all Design Center projects

designcenter:project:publish

Publishes a Design Center project to Exchange

designcenter:project:upload

Uploads the content of a project to Design Center

Exchange Assets

Command	Description
exchange:asset:copy	Copies an Exchange asset
exchange:asset:delete	Deletes an asset from Exchange
exchange:asset:deprecate	Deprecates an asset
exchange:asset:describe	Shows a given asset’s information
exchange:asset:download	Downloads an Exchange asset
exchange:asset:list	Lists all assets
exchange:asset:modify	Modifies an Exchange asset
exchange:asset:mutableDataUpload	Modifies mutable data of an existing Exchange asset
exchange:asset:page:delete	Deletes an asset’s description page from Exchange
exchange:asset:page:download	Downloads an asset’s description page from Exchange
exchange:asset:page:list	List all pages for a given asset
exchange:asset:page:modify	Changes an asset’s description page from Exchange
exchange:asset:page:update	Updates an asset’s description page from Exchange
exchange:asset:page:upload	Uploads an asset’s description page from Exchange
exchange:asset:resource:delete	Deletes resource from the asset portal
exchange:asset:resource:download	Downloads resource from the asset portal
exchange:asset:resource:list	Lists published resources in the asset portal
exchange:asset:resource:upload	Uploads a resource to an asset portal
exchange:asset:undeprecate	Undeprecates an asset
exchange:asset:updateStatus	Modifies the status of an existing asset
exchange:asset:upload	Uploads an Exchange asset using Exchange Experience API

Command

Description

exchange:asset:copy

Copies an Exchange asset

exchange:asset:delete

Deletes an asset from Exchange

exchange:asset:deprecate

Deprecates an asset

exchange:asset:describe

Shows a given asset’s information

exchange:asset:download

Downloads an Exchange asset

exchange:asset:list

Lists all assets

exchange:asset:modify

Modifies an Exchange asset

exchange:asset:mutableDataUpload

Modifies mutable data of an existing Exchange asset

exchange:asset:page:delete

Deletes an asset’s description page from Exchange

exchange:asset:page:download

Downloads an asset’s description page from Exchange

exchange:asset:page:list

List all pages for a given asset

exchange:asset:page:modify

Changes an asset’s description page from Exchange

exchange:asset:page:update

Updates an asset’s description page from Exchange

exchange:asset:page:upload

Uploads an asset’s description page from Exchange

exchange:asset:resource:delete

Deletes resource from the asset portal

exchange:asset:resource:download

Downloads resource from the asset portal

exchange:asset:resource:list

Lists published resources in the asset portal

exchange:asset:resource:upload

Uploads a resource to an asset portal

exchange:asset:undeprecate

Undeprecates an asset

exchange:asset:updateStatus

Modifies the status of an existing asset

exchange:asset:upload

Uploads an Exchange asset using Exchange Experience API

Exchange commands are currently not available for GovCloud.

Hybrid Applications

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

Command	Description
runtime-mgr:standalone-application:artifact	Downloads a standalone application artifact binary
runtime-mgr:standalone-application:copy	Copies a standalone application
runtime-mgr:standalone-application:delete	Deletes a standalone application
runtime-mgr:standalone-application:deploy	Deploys or redeploys an application to an on-premises server, server group, or cluster
runtime.mgr:standalone-application:describe	Shows detailed information for a standalone application
runtime-mgr:standalone-application:list	Lists all standalone applications in the environment
runtime-mgr:standalone-application:modify	Changes a standalone application artifact
runtime-mgr:standalone-application:restart	Restarts a standalone application
runtime-mgr:standalone-application:start	Starts a standalone application
runtime-mgr:standalone-application:stop	Stops a standalone application

Command

Description

runtime-mgr:standalone-application:artifact

Downloads a standalone application artifact binary

runtime-mgr:standalone-application:copy

Copies a standalone application

runtime-mgr:standalone-application:delete

Deletes a standalone application

runtime-mgr:standalone-application:deploy

Deploys or redeploys an application to an on-premises server, server group, or cluster

runtime.mgr:standalone-application:describe

Shows detailed information for a standalone application

runtime-mgr:standalone-application:list

Lists all standalone applications in the environment

runtime-mgr:standalone-application:modify

Changes a standalone application artifact

runtime-mgr:standalone-application:restart

Restarts a standalone application

runtime-mgr:standalone-application:start

Starts a standalone application

runtime-mgr:standalone-application:stop

Stops a standalone application

Alerts for Hybrid Applications

Command	Description
runtime-mgr:standalone-alert:create	Creates new alert for standalone runtime
runtime-mgr:standalone-alert:describe	Describes an alert
runtime-mgr:standalone-alert:list	Lists all alerts for standalone runtimes in the environment
runtime-mgr:standalone-alert:modify	Modifies alert for standalone runtime

Command

Description

runtime-mgr:standalone-alert:create

Creates new alert for standalone runtime

runtime-mgr:standalone-alert:describe

Describes an alert

runtime-mgr:standalone-alert:list

Lists all alerts for standalone runtimes in the environment

runtime-mgr:standalone-alert:modify

Modifies alert for standalone runtime

Local Servers

Command	Description
runtime-mgr:server:describe	Describes server
runtime-mgr:server:delete	Deletes server
runtime-mgr:server:list	Changes an standalone application artifact
runtime-mgr:server:modify	Modifies server
runtime-mgr:server:token	Gets server registration token. This token needs to be used to register a new server

Command

Description

runtime-mgr:server:describe

Describes server

runtime-mgr:server:delete

Deletes server

runtime-mgr:server:list

Changes an standalone application artifact

runtime-mgr:server:modify

Modifies server

runtime-mgr:server:token

Gets server registration token. This token needs to be used to register a new server

Local Server Groups

Command	Description
runtime-mgr:serverGroup:add:server	Adds server to a server group
runtime-mgr:serverGroup:create	Creates server group from servers
runtime-mgr:serverGroup:describe	Describes server group
runtime-mgr:serverGroup:delete	Deletes server group
runtime-mgr:serverGroup:list	Lists all server groups in the environment
runtime-mgr:serverGroup:modify	Modifies server group
runtime-mgr:serverGroup:remove:server	Removes server from a server group

Command

Description

runtime-mgr:serverGroup:add:server

Adds server to a server group

runtime-mgr:serverGroup:create

Creates server group from servers

runtime-mgr:serverGroup:describe

Describes server group

runtime-mgr:serverGroup:delete

Deletes server group

runtime-mgr:serverGroup:list

Lists all server groups in the environment

runtime-mgr:serverGroup:modify

Modifies server group

runtime-mgr:serverGroup:remove:server

Removes server from a server group

Local Server Clusters

Command	Description
runtime-mgr:cluster:add:server	Adds server to cluster
runtime-mgr:cluster:create	Creates new cluster
runtime-mgr:cluster:describe	Describes server cluster
runtime-mgr:cluster:delete	Deletes cluster
runtime-mgr:cluster:modify	Modifies cluster
runtime-mgr:cluster:list	Lists all clusters in the environment
runtime-mgr:cluster:remove:server	Removes server from a cluster

Command

Description

runtime-mgr:cluster:add:server

Adds server to cluster

runtime-mgr:cluster:create

Creates new cluster

runtime-mgr:cluster:describe

Describes server cluster

runtime-mgr:cluster:delete

Deletes cluster

runtime-mgr:cluster:modify

Modifies cluster