W-22219984-ch-API-endpoints-reorg-kt #877
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| = CloudHub API Reference | ||
| ifndef::env-site,env-github[] | ||
| include::_attributes.adoc[] | ||
| endif::[] | ||
|
|
||
| These tables list the most commonly used CloudHub 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 https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/[interactive API reference on Exchange]. | ||
|
|
||
| === Applications | ||
|
|
||
| [%header,cols="10,45,45"] | ||
| |=== | ||
| |Method |Endpoint |Description | ||
| |`GET` |`/applications` |List all applications. | ||
|
Contributor
There was a problem hiding this comment. (Globally) Only full sentences should take final period. |
||
| |`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 xref:managing-applications-on-cloudhub.adoc[]. | ||
|
|
||
| === Logs | ||
|
|
||
| [%header,cols="10,45,45"] | ||
| |=== | ||
| |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 | ||
|
|
||
| [%header,cols="10,45,45"] | ||
| |=== | ||
| |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 xref:custom-application-alerts.adoc[]. | ||
|
|
||
| === Schedules | ||
|
|
||
| [%header,cols="10,45,45"] | ||
| |=== | ||
| |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 xref:managing-schedules.adoc[]. | ||
|
|
||
| === Load Balancers | ||
|
|
||
| [%header,cols="10,45,45"] | ||
| |=== | ||
| |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 xref:lb-create-api.adoc[], xref:lb-cert-validation.adoc[], xref:lb-mapping-rules.adoc[], and xref:lb-download-logs.adoc[]. | ||
|
|
||
| === VPCs, VPNs, and Transit Gateways | ||
|
|
||
| [%header,cols="10,45,45"] | ||
| |=== | ||
| |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 xref:create-vpc-cli.adoc[]. | ||
|
|
||
| === Diagnostics | ||
|
|
||
| [%header,cols="10,45,45"] | ||
| |=== | ||
| |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 xref:ch-diagnostics-agent.adoc[]. | ||
|
|
||
|
|
||
| == See Also | ||
|
|
||
| * xref:cloudhub-api.adoc[] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.