Contact Us 1-800-596-4880
  1. Homepage
  2. CloudHub
  3. CloudHub API

  4. CloudHub API Reference

CloudHub API Reference

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.

Applications

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

Method Endpoint Description

GET

/applications

List all applications.

POST

/applications

Create and deploy a new application.

GET

/applications/{domain}

Get details for a specific application.

PUT

/applications/{domain}

Update application metadata (workers, runtime version, properties).

DELETE

/applications/{domain}

Delete an application.

For more information, see Manage Applications on CloudHub.

Logs

Use these endpoints to search and download application log entries.

Method Endpoint Description

POST

/v2/applications/{domain}/logs

Search application log entries.

GET

/v2/applications/{domain}/deployments/{deploymentId}/logs

Retrieve logs for a specific deployment.

GET

/v2/applications/{domain}/instances/{instanceId}/logs

Retrieve logs for a specific instance.

GET

/v2/applications/{domain}/instances/{instanceId}/log-file

Download the log file for a specific instance.

Notifications and Alerts

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

Method Endpoint Description

GET

/notifications

List notifications.

POST

/notifications

Create a notification.

PUT

/notifications/{notificationId}

Mark a notification as read or unread.

GET

/v2/alerts

List alerts for an application.

POST

/v2/alerts

Create an alert.

PUT

/v2/alerts/{alertId}

Update an alert.

DELETE

/v2/alerts/{alertId}

Delete an alert.

For more information, see Custom Application Alerts and Notifications.

Schedules

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

Method Endpoint Description

GET

/applications/{domain}/schedules

List all schedules for an application.

PUT

/applications/{domain}/schedules

Update all schedules for an application.

PUT

/applications/{domain}/schedules/{scheduleId}

Update a specific schedule.

For more information, see Manage Schedules.

Load Balancers

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

Method Endpoint Description

GET

/organizations/{orgId}/loadbalancers

List load balancers in an organization.

POST

/organizations/{orgId}/vpcs/{vpcId}/loadbalancers

Create a load balancer.

GET

/organizations/{orgId}/vpcs/{vpcId}/loadbalancers/{lbId}

Get details for a specific load balancer.

PATCH

/organizations/{orgId}/vpcs/{vpcId}/loadbalancers/{lbId}

Update a load balancer (mapping rules, certificates, cipher suites).

DELETE

/organizations/{orgId}/vpcs/{vpcId}/loadbalancers/{lbId}

Delete a load balancer.

GET

/organizations/{orgId}/loadbalancers/ciphersuites

List available cipher suites.

POST

/organizations/{orgId}/logs/download

Initiate a DLB log download.

GET

/organizations/{orgId}/logs/download/status

Check DLB log download status.

For detailed curl examples, see Create a Load Balancer with the CloudHub API, Certificate Validation in Dedicated Load Balancers, Dedicated Load Balancer Mapping Rules, and Download Dedicated Load Balancer 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.

Method Endpoint Description

GET

/organizations/{orgId}/vpcs

List VPCs in an organization.

POST

/organizations/{orgId}/vpcs

Create a VPC.

PUT

/organizations/{orgId}/vpcs/{vpcId}

Update a VPC (associated environments, firewall rules).

DELETE

/organizations/{orgId}/vpcs/{vpcId}

Remove a VPC.

POST

/organizations/{orgId}/vpcs/{vpcId}/ipsec

Create a VPN connection.

DELETE

/organizations/{orgId}/vpcs/{vpcId}/ipsec/{vpnId}

Delete a VPN connection.

GET

/organizations/{orgId}/tgws

List Transit Gateway attachments in an organization.

POST

/organizations/{orgId}/tgws

Create a Transit Gateway attachment.

PUT

/organizations/{orgId}/tgws/{tgwId}

Update a Transit Gateway attachment.

DELETE

/organizations/{orgId}/tgws/{tgwId}

Remove a Transit Gateway attachment.

For detailed curl examples, see Create a VPC with the Anypoint Platform CLI.

Diagnostics

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

Method Endpoint Description

GET

/v2/applications/{domain}/instances/diagnostics

List diagnostics for an application.

GET

/v2/applications/{domain}/instances/{instanceId}/diagnostics

Get diagnostics for an instance without persisting them.

POST

/v2/applications/{domain}/instances/{instanceId}/diagnostics

Generate and persist diagnostics for an instance.

GET

/v2/applications/{domain}/instances/diagnostics/{diagnosticId}/download

Download a diagnostic.

GET

/v2/applications/{domain}/instances/diagnostics/analysis-readiness

Check if analysis can be triggered.

GET

/v2/applications/{domain}/instances/{instanceId}/diagnostics/analysis/latest

Get the latest analysis for an instance.

POST

/v2/applications/{domain}/instances/{instanceId}/diagnostics/analyze

Trigger an analysis for an instance.

For more information, see Generate Apps Diagnostics and Analyze with Einstein.

See Also