MuleSoft’s CloudHub management API lets you automate Runtime Manager tasks over HTTP, including listing and managing applications and working with operational resources. To make a request, use a bearer token and the correct organization and environment IDs. First confirm whether your deployment uses the classic CloudHub API or CloudHub 2.0 APIs: the API generation and control plane affect which endpoints and hostnames apply.
What the CloudHub API can do
MuleSoft describes the CloudHub management API as a way to programmatically access Runtime Manager functions. Its documented surface includes application lifecycle operations, runtime information, and platform resources. The API reference base URL is https://anypoint.mulesoft.com/cloudhub/api; use the current API reference for the endpoint, method, request schema, and response details for the operation you need.
- Applications: create, deploy, start, stop, delete, and update applications. Documented changes include worker count, Mule runtime version, and system properties.
- Operations and diagnostics: retrieve logs, statistics, transactions, and events; manage notifications and alerts.
- Platform resources: work with schedules, load balancers, VPCs, VPNs, transit gateways, persistent queues, workers, and diagnostics, subject to the API generation and feature support for the deployment.
An Anypoint Exchange listing also says the API exposes memory and CPU usage and Mule-message statistics, with a one-month retention policy for statistics. Treat that retention statement as the listing’s description; verify the applicable behavior for your deployment.
Choose the API for your deployment
CloudHub and CloudHub 2.0 are related MuleSoft hosting platforms, but a client should not assume that a classic CloudHub API endpoint or workflow applies unchanged to CloudHub 2.0. Identify the target deployment and its control plane before building automation.
#1 Best Overall
| Decision point | Classic CloudHub | CloudHub 2.0 |
|---|---|---|
| Platform description | MuleSoft’s iPaaS for deploying integration applications and APIs. | A fully managed, containerized iPaaS; MuleSoft describes elastic scaling, security policies, encrypted secrets and configuration in transit and at rest, and a separate container isolation boundary for each Mule instance and service. |
| API choice | Use the classic CloudHub management API for supported Runtime Manager operations on the target deployment. | Confirm the CloudHub 2.0 API or Runtime Manager route for the specific operation. Some scheduler behavior is handled through CloudHub 2.0 APIs or Runtime Manager. |
| Host and region | Use the hostname for the relevant control plane. | Hostname patterns vary by control plane. US Cloud examples omit a region suffix before cloudhub.io; examples for some non-US control planes use suffixes such as eu1, ca1, jp1, or in1. Obtain the deployment URL from the target control plane rather than constructing it from a presumed pattern. |
Prepare authentication and request scope
Before calling a management operation, obtain an authorization bearer token, an organization ID, and an environment ID. MuleSoft’s guide points to /api/me for organization context and /api/organizations/ORG_ID/environments for environment discovery. The token-owning identity also needs permissions appropriate to the requested operation.
Send the token in an Authorization: Bearer header and scope the request with X-ANYPNT-ORG-ID and X-ANYPNT-ENV-ID. Requests and responses use JSON. Keep bearer tokens out of source control and logs; the guide specifies the credential and headers but does not mandate a particular secrets-management product.
List applications with curl
This documented request lists applications in the selected organization and environment. Replace the three placeholders with values for the intended scope.
curl -X GET
--url https://anypoint.mulesoft.com/cloudhub/api/applications
-H 'authorization: Bearer AUTH_BEARER_TOKEN'
-H 'X-ANYPNT-ENV-ID: ENV_ID'
-H 'X-ANYPNT-ORG-ID: ORG_ID'A successful response is JSON. If the request fails, verify that the token is valid, that the organization and environment IDs belong to the intended context, that the identity has permission to list applications, and that the host and API generation match the deployment. Use the current endpoint reference for response codes and endpoint-specific errors.
Do these 3 things before closing this tab:
1Clear out junk files and repair common Windows errors2Scan for outdated or missing drivers - takes under a minute3Repair Windows errors before they cause bigger problemsRank #3
Build an automation workflow
- Identify the target. Determine whether the application runs on classic CloudHub or CloudHub 2.0, and get the deployment URL from its control plane.
- Resolve organization and environment scope. Use the organization context and environment discovery paths in MuleSoft’s guide, then record the intended IDs in your automation configuration.
- Obtain and protect a bearer token. Use the authentication flow appropriate to your Anypoint setup. The material described here does not specify a single token-acquisition command or flow, so do not assume one; follow the current MuleSoft authentication documentation for your identity type.
- Test read access. Call
GET /applicationswith the bearer token and scope headers before automating changes. - Choose the lifecycle operation. Use the documented application operations to deploy, start, stop, delete, or change supported settings such as workers, Mule runtime version, or system properties. Check the endpoint reference for the exact HTTP method, payload, and supported values; they are operation-specific.
- Add observability and recovery. Use the relevant logs, statistics, transactions, events, notifications, and alerts resources to monitor the application and diagnose failures. Include an appropriate recovery path in the automation for failed deployments or changes.
Plan around API and operational boundaries
Separate lifecycle actions from operational resources
Application deployment and configuration changes are distinct from observing runtime behavior or managing network and platform resources. Give automation only the permissions it needs, and keep those workflows separate where practical: a deployment process does not necessarily need authority to change VPCs, VPNs, or load balancers.
Check endpoint-specific limits and behavior
The cited MuleSoft material does not establish a general performance benchmark, latency target, or throughput figure for CloudHub API calls. Rate limits should be checked in the current interactive API reference for the specific endpoint and plan; do not assume one limit applies to every operation.
Verify CloudHub 2.0 feature routing
For CloudHub 2.0, validate how the desired function is exposed before coding against the classic API. This matters particularly for schedules, where some behavior is handled through CloudHub 2.0 APIs or Runtime Manager rather than being assumed to match a classic CloudHub endpoint.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
