---
schema_version: "1"
id: a3657a466eda5aa744dc1703b265f82cb36527cb2d4ec93bce0f1e58850d714e
title: CloudHub API Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/cloudhub/cloudhub-api-reference.md
canonical_url: https://docs.mulesoft.com/cloudhub/cloudhub-api-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 618172d6099664a78c87347c1e7240e24494cf1dfaab6fcb94162ca6fbf754ba
description: MuleSoft Documentation Site
latest: true
---
---
product: CloudHub
---

# CloudHub API Reference

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

These tables list the most commonly used CloudHub Application Programming Interface (API) endpoints
grouped by category. All endpoints use the base URL `https://anypoint.mulesoft.com/cloudhub/api`.

For full details on request parameters, payloads, and responses, see the
[interactive API reference on Exchange](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/).

## Applications

Use these endpoints to deploy, manage, and delete Mule applications running on CloudHub.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Method</th><th>Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><p><code>GET</code></p></td><td><p><code>/applications</code></p></td><td><p>List all applications.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/applications</code></p></td><td><p>Create and deploy a new application.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/applications/{domain}</code></p></td><td><p>Get details for a specific application.</p></td></tr><tr><td><p><code>PUT</code></p></td><td><p><code>/applications/{domain}</code></p></td><td><p>Update application metadata (workers, runtime version, properties).</p></td></tr><tr><td><p><code>DELETE</code></p></td><td><p><code>/applications/{domain}</code></p></td><td><p>Delete an application.</p></td></tr></tbody></table>

For more information, see [Manage Applications on CloudHub](https://docs.mulesoft.com/cloudhub/managing-applications-on-cloudhub).

## Logs

Use these endpoints to search and download application log entries.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Method</th><th>Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><p><code>POST</code></p></td><td><p><code>/v2/applications/{domain}/logs</code></p></td><td><p>Search application log entries.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/v2/applications/{domain}/deployments/{deploymentId}/logs</code></p></td><td><p>Retrieve logs for a specific deployment.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/v2/applications/{domain}/instances/{instanceId}/logs</code></p></td><td><p>Retrieve logs for a specific instance.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/v2/applications/{domain}/instances/{instanceId}/log-file</code></p></td><td><p>Download the log file for a specific instance.</p></td></tr></tbody></table>

When filtering by time range, the `startTime` and `endTime` parameters require ISO 8601 UTC format
with microsecond precision (`YYYY-MM-DDTHH:mm:ss.SSSSSSZ`), for example,
`2025-12-25T10:00:00.000000Z`. These parameters don’t accept epoch (Unix) timestamps.

## Notifications and Alerts

Use these endpoints to manage notifications and configure alerts for your CloudHub applications.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Method</th><th>Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><p><code>GET</code></p></td><td><p><code>/notifications</code></p></td><td><p>List notifications.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/notifications</code></p></td><td><p>Create a notification.</p></td></tr><tr><td><p><code>PUT</code></p></td><td><p><code>/notifications/{notificationId}</code></p></td><td><p>Mark a notification as read or unread.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/v2/alerts</code></p></td><td><p>List alerts for an application.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/v2/alerts</code></p></td><td><p>Create an alert.</p></td></tr><tr><td><p><code>PUT</code></p></td><td><p><code>/v2/alerts/{alertId}</code></p></td><td><p>Update an alert.</p></td></tr><tr><td><p><code>DELETE</code></p></td><td><p><code>/v2/alerts/{alertId}</code></p></td><td><p>Delete an alert.</p></td></tr></tbody></table>

For more information, see [Custom Application Alerts and Notifications](https://docs.mulesoft.com/cloudhub/custom-application-alerts).

## Schedules

Use these endpoints to view and update scheduled jobs for your CloudHub applications.

> [!NOTE] These schedules endpoints don’t return scheduler or domain details for CloudHub 2.0
> applications. To manage schedulers for CloudHub 2.0 apps, use the CloudHub 2.0 APIs or the Runtime
> Manager **Schedules** tab. See [Managing App Schedules](https://docs.mulesoft.com/cloudhub-2/ch2-manage-schedules).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Method</th><th>Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><p><code>GET</code></p></td><td><p><code>/applications/{domain}/schedules</code></p></td><td><p>List all schedules for an application.</p></td></tr><tr><td><p><code>PUT</code></p></td><td><p><code>/applications/{domain}/schedules</code></p></td><td><p>Update all schedules for an application.</p></td></tr><tr><td><p><code>PUT</code></p></td><td><p><code>/applications/{domain}/schedules/{scheduleId}</code></p></td><td><p>Update a specific schedule.</p></td></tr></tbody></table>

For more information, see [Manage Schedules](https://docs.mulesoft.com/cloudhub/managing-schedules).

## Load Balancers

Use these endpoints to create, configure, and manage dedicated load balancers (DLBs) for your
CloudHub applications.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Method</th><th>Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><p><code>GET</code></p></td><td><p><code>/organizations/{orgId}/loadbalancers</code></p></td><td><p>List load balancers in an organization.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/organizations/{orgId}/vpcs/{vpcId}/loadbalancers</code></p></td><td><p>Create a load balancer.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/organizations/{orgId}/vpcs/{vpcId}/loadbalancers/{lbId}</code></p></td><td><p>Get details for a specific load balancer.</p></td></tr><tr><td><p><code>PATCH</code></p></td><td><p><code>/organizations/{orgId}/vpcs/{vpcId}/loadbalancers/{lbId}</code></p></td><td><p>Update a load balancer (mapping rules, certificates, cipher suites).</p></td></tr><tr><td><p><code>DELETE</code></p></td><td><p><code>/organizations/{orgId}/vpcs/{vpcId}/loadbalancers/{lbId}</code></p></td><td><p>Delete a load balancer.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/organizations/{orgId}/loadbalancers/ciphersuites</code></p></td><td><p>List available cipher suites.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/organizations/{orgId}/logs/download</code></p></td><td><p>Initiate a DLB log download.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/organizations/{orgId}/logs/download/status</code></p></td><td><p>Check DLB log download status.</p></td></tr></tbody></table>

For detailed curl examples, see [Create a Load Balancer with the CloudHub API](https://docs.mulesoft.com/cloudhub/lb-create-api),
[Certificate Validation in Dedicated Load Balancers](https://docs.mulesoft.com/cloudhub/lb-cert-validation),
[Dedicated Load Balancer Mapping Rules](https://docs.mulesoft.com/cloudhub/lb-mapping-rules), and
[Download Dedicated Load Balancer Logs](https://docs.mulesoft.com/cloudhub/lb-download-logs).

## VPCs, VPNs, and Transit Gateways

Use these endpoints to manage Virtual Private Clouds (VPCs), Virtual Private Networks (VPNs), and
transit gateway attachments for your CloudHub network infrastructure.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Method</th><th>Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><p><code>GET</code></p></td><td><p><code>/organizations/{orgId}/vpcs</code></p></td><td><p>List VPCs in an organization.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/organizations/{orgId}/vpcs</code></p></td><td><p>Create a VPC.</p></td></tr><tr><td><p><code>PUT</code></p></td><td><p><code>/organizations/{orgId}/vpcs/{vpcId}</code></p></td><td><p>Update a VPC (associated environments, firewall rules).</p></td></tr><tr><td><p><code>DELETE</code></p></td><td><p><code>/organizations/{orgId}/vpcs/{vpcId}</code></p></td><td><p>Remove a VPC.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/organizations/{orgId}/vpcs/{vpcId}/ipsec</code></p></td><td><p>Create a VPN connection.</p></td></tr><tr><td><p><code>DELETE</code></p></td><td><p><code>/organizations/{orgId}/vpcs/{vpcId}/ipsec/{vpnId}</code></p></td><td><p>Delete a VPN connection.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/organizations/{orgId}/tgws</code></p></td><td><p>List Transit Gateway attachments in an organization.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/organizations/{orgId}/tgws</code></p></td><td><p>Create a Transit Gateway attachment.</p></td></tr><tr><td><p><code>PUT</code></p></td><td><p><code>/organizations/{orgId}/tgws/{tgwId}</code></p></td><td><p>Update a Transit Gateway attachment.</p></td></tr><tr><td><p><code>DELETE</code></p></td><td><p><code>/organizations/{orgId}/tgws/{tgwId}</code></p></td><td><p>Remove a Transit Gateway attachment.</p></td></tr></tbody></table>

For detailed curl examples, see [Create a VPC with the Anypoint Platform CLI](https://docs.mulesoft.com/cloudhub/create-vpc-cli).

## Diagnostics

Use these endpoints to generate, retrieve, and analyze application diagnostics.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Method</th><th>Endpoint</th><th>Description</th></tr></thead><tbody><tr><td><p><code>GET</code></p></td><td><p><code>/v2/applications/{domain}/instances/diagnostics</code></p></td><td><p>List diagnostics for an application.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/v2/applications/{domain}/instances/{instanceId}/diagnostics</code></p></td><td><p>Get diagnostics for an instance without persisting them.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/v2/applications/{domain}/instances/{instanceId}/diagnostics</code></p></td><td><p>Generate and persist diagnostics for an instance.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/v2/applications/{domain}/instances/diagnostics/{diagnosticId}/download</code></p></td><td><p>Download a diagnostic.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/v2/applications/{domain}/instances/diagnostics/analysis-readiness</code></p></td><td><p>Check if analysis can be triggered.</p></td></tr><tr><td><p><code>GET</code></p></td><td><p><code>/v2/applications/{domain}/instances/{instanceId}/diagnostics/analysis/latest</code></p></td><td><p>Get the latest analysis for an instance.</p></td></tr><tr><td><p><code>POST</code></p></td><td><p><code>/v2/applications/{domain}/instances/{instanceId}/diagnostics/analyze</code></p></td><td><p>Trigger an analysis for an instance.</p></td></tr></tbody></table>

For more information, see
[Generate Apps Diagnostics and Analyze with Einstein](https://docs.mulesoft.com/cloudhub/ch-diagnostics-agent).

## See Also

- [CloudHub API](https://docs.mulesoft.com/cloudhub/cloudhub-api)