Anypoint CLI 3.x List of Commands
Anypoint Platform CLI provides the ability to manage these features in Anypoint Platform:
Anypoint Platform Account
| Command | Description |
|---|---|
Show account details |
|
Lists business groups |
|
Show details of a business group |
|
Lists environments |
|
Create new environment |
|
Delete an environment |
|
Shows details of an environment |
Environments and Business Groups
| Command | Description |
|---|---|
Make specified environment active |
|
Make specified business-group active |
API Governance
Command |
Description |
Evaluates filter criteria to determine which rulesets apply to APIs that meet that criteria |
|
Inspects an API definition and lists its schemas |
|
Validates an API definition against a specified governance ruleset |
|
Creates the documentation file for a governance ruleset definition |
|
Creates a governance profile |
|
Deletes a governance profile |
|
Lists information for a specific governance profile ID |
|
Lists all governance profiles for an organization |
|
Updates a governance profile |
|
Clones a governance ruleset and applies specified updates to rules |
|
Lists ruleset rules |
|
Initializes a governance ruleset definition based on a data schema |
|
Validates a governance ruleset definition’s format |
API Manager
| Command | Description |
|---|---|
Creates an API instance alert |
|
Lists alerts for an API instance |
|
Changes the asset version for an API instance by choosing a new version from Exchange |
|
Classifies an API instance in a given environment |
|
Deletes an API |
|
Deploys an API to CloudHub, hybrid server, or Runtime Fabric |
|
Deprecates an API instance |
|
Shows details of an API |
|
Downloads the API proxy ZIP file to a local directory |
|
Edits an API instance |
|
Lists all APIs in API Manager 2.x |
|
Manages a new API, API version, or new API instance with an asset from Exchange |
|
Promotes an API instance from source environment |
|
Redeploys an API to CloudHub, Hybrid server, or Runtime Fabric |
|
Undeprecates an API instance |
|
Deletes a given API contract |
|
Lists all contracts to a given API instance. |
|
Applies a policy to a given API instance |
|
Shows the description and available configuration properties of a given policy template |
|
Disables policy from a given API instance |
|
Edits the policy configuration of a given API instance |
|
Enables a policy on a given API instance |
|
Lists policies |
|
Removes a policy from a given API instance |
|
Creates an SLA tier |
|
Copies an SLA tier from source to a target API Instance |
|
Deletes an SLA tier from an API instance |
|
Lists the SLA tiers of an API instance |
Cloudhub 2.0
| Command | Description |
|---|---|
Deletes an application |
|
Deploys an application to a specified target using an Exchange application and runs the specified runtime version |
|
Describes an application |
|
Describes an application in raw JSON response |
|
Downloads logs of an application from a specification to a specified directory |
|
Lists all applications in an organization |
|
Modifies a deployed application |
|
Starts a stopped application |
|
Stops running an application |
|
Tails an application’s logs from a specification |
CloudHub Applications
| Command | Description |
|---|---|
Lists all alerts in the environment |
|
Describes the history of the alarm |
|
Lists all applications in the environment |
|
Show application details |
|
Show raw application JSON response |
|
Stop a running application |
|
Start an application |
|
Restart a running application |
|
Delete an application |
|
Deploy a new application |
|
Modify an existing application, optionally updating the ZIP file |
|
Download application logs to specified directory |
|
Tail application logs |
|
Copies a CloudHub application |
CloudHub Dedicated Load Balancers
| Command | Description |
|---|---|
Lists all load balancers in an organization |
|
Show load balancer details |
|
Show load balancer details in raw JSON response |
|
Create a load balancer |
|
Starts a load balancer |
|
Stops a load balancer |
|
Delete a load balancer |
|
Add an additional certificate to an existing load balancer |
|
Remove a certificate from a load balancer |
|
Set the default certificate that the load balancer will serve |
|
Show the load balancer configuration for a particular certificate |
|
Add an IP or range of IPs to the load balancer allowlist |
|
Remove an IP or range of IPs from the load balancer allowlist |
|
Lists the proxy mapping rules for a load balancer. If no |
|
Add a proxy mapping rule at the specified index. If no |
|
Remove a proxy mapping rule. If no |
|
Enables dynamic IPs |
|
Disables dynamic IPs |
|
Lists all supported regions |
|
Lists all available runtimes |
CloudHub Anypoint VPCs
| Command | Description |
|---|---|
Lists all Anypoint VPCs |
|
Show Anypoint VPC details |
|
Show raw Anypoint VPC JSON response |
|
Create a new Anypoint VPC |
|
Delete an existing Anypoint VPC |
|
Modifies the Anypoint VPC association to Runtime Manager environments. |
|
Modifies the Anypoint VPC association to Runtime Manager environments. |
|
Share an Anypoint VPC with a list of Business Groups. |
|
Share an Anypoint VPC with a list of Business Groups. |
|
Sets the domain names that are resolved using your internal DNS servers. If used with no option, internal DNS will be disabled |
|
Clears the list domain names that are resolved using your internal DNS servers |
|
Show firewall rule for Mule applications in this Anypoint VPC |
|
Add a firewall rule for Mule applications in this Anypoint VPC |
|
Remove a firewall rule for Mule applications in this Anypoint VPC |
DataGraph Load Balancers
| Command | Description |
|---|---|
Adds a dedicated load balancer configuration to Anypoint DataGraph |
|
Displays a dedicated load balancer configuration for Anypoint DataGraph |
|
Removes a dedicated load balancer configuration from Anypoint DataGraph |
DataGraph API Source Management
| Command | Description |
|---|---|
Adds an API source |
|
Promotes an API source |
|
Updates an API source |
|
Scales API calls made to the unified schema |
|
Downloads the unified schema |
|
Deletes an API source |
|
Gets an API source |
|
Lists all API sources |
|
Returns information about DataGraph |
Design Center Projects
| Command | Description |
|---|---|
Creates a new Design Center project |
|
Deletes a Design Center project |
|
Downloads the content of a Design Center project |
|
Publishes a Design Center project to Exchange |
|
Uploads the content of a project to Design Center |
|
List all Design Center projects |
Exchange Assets
| Command | Description |
|---|---|
Uploads an Exchange asset |
|
Uploads an Exchange asset using Exchange Experience API v2 |
|
Modifies mutable data of an existing Exchange asset |
|
Modifies an Exchange asset |
|
Downloads an Exchange asset |
|
Lists all assets |
|
Downloads an asset’s description page from Exchange |
|
Changes an asset’s description page from Exchange |
|
Uploads an asset’s description page from Exchange |
|
Updates an asset’s description page from Exchange |
|
Deletes an asset’s description page from Exchange |
|
List all pages for a given asset |
|
Copies an Exchange asset |
|
Deletes an asset from Exchange |
|
Deprecates an asset |
|
Undeprecate an asset |
|
Show a given asset’s information |
|
Uploads a resource to an asset portal |
|
Lists published resources in the asset portal |
|
Downloads resource from the asset portal |
|
Deletes resource from the asset portal |
Hybrid Applications
| In order for the Anypoint Platform CLI to recognize your target servers, each server needs to be manually registered with the platform. |
| Command | Description |
|---|---|
Downloads a standalone application artifact binary |
|
Deploys or redeploys an application to an on-premises server, server group, or cluster |
|
Shows a raw standalone application JSON response |
|
Changes a standalone application artifact |
|
Starts a standalone application |
|
Deletes a standalone application |
|
Shows detailed information for a standalone application |
|
Lists all standalone applications in the environment |
|
Restarts a standalone application |
|
Stops a standalone application |
|
Copies a standalone application |
Alerts for Hybrid Applications
| Command | Description |
|---|---|
Describes an alert |
|
Creates new alert for standalone runtime |
|
Modifies alert for standalone runtime |
|
Lists all alerts for standalone runtimes in the environment |
Local Servers
| Command | Description |
|---|---|
Describes server |
|
Modifies server |
|
Gets server registration token. This token needs to be used to register a new server |
|
Deletes server |
|
Changes an standalone application artifact |
Local Server Groups
| Command | Description |
|---|---|
Creates server group from servers |
|
Describes server group |
|
Modifies server group |
|
Adds server to a server group |
|
Deletes server group |
|
Lists all server groups in the environment |
|
Removes server from a server group |
Local Cluster Servers
| Command | Description |
|---|---|
Adds server to cluster |
|
Deletes cluster |
|
Lists all clusters in the environment |
|
Removes server from a cluster |
|
Creates new cluster |
|
Describes server cluster |
|
Modifies cluster |
Runtime Fabric Application Management
| Command | Description |
|---|---|
Deletes an application |
|
Deploys an application to a specified target using an Exchange application and runs the specified runtime version |
|
Describes an application |
|
Describes an application in a raw JSON response |
|
Downloads logs of an application from a specification to a specified directory |
|
Lists all applications in an organization |
|
Modifies a deployed application |
|
Starts a stopped application |
|
Stops running an application |
|
Tails an application’s logs from a specification |