diff --git a/cloudhub/modules/ROOT/nav.adoc b/cloudhub/modules/ROOT/nav.adoc index 3d36d70d8..430050f77 100644 --- a/cloudhub/modules/ROOT/nav.adoc +++ b/cloudhub/modules/ROOT/nav.adoc @@ -68,3 +68,4 @@ ** xref:tgw-troubleshoot.adoc[Troubleshoot Transit Gateway Attachments] * xref:cloudhub-cli.adoc[CloudHub CLI] * xref:cloudhub-api.adoc[CloudHub API] + ** xref:cloudhub-api-reference.adoc[CloudHub API Reference] diff --git a/cloudhub/modules/ROOT/pages/cloudhub-api-reference.adoc b/cloudhub/modules/ROOT/pages/cloudhub-api-reference.adoc new file mode 100644 index 000000000..ff5fbbb7e --- /dev/null +++ b/cloudhub/modules/ROOT/pages/cloudhub-api-reference.adoc @@ -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. +|`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[] diff --git a/cloudhub/modules/ROOT/pages/cloudhub-api.adoc b/cloudhub/modules/ROOT/pages/cloudhub-api.adoc index 549d3231e..01a3f9611 100644 --- a/cloudhub/modules/ROOT/pages/cloudhub-api.adoc +++ b/cloudhub/modules/ROOT/pages/cloudhub-api.adoc @@ -215,6 +215,7 @@ Date: Mon, 10 Aug 2015 00:12:55 GMT == See Also +* xref:cloudhub-api-reference.adoc[] * https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/[CloudHub API] * https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/[Access Management API] * xref:runtime-manager::deployment-strategies.adoc[Deployment Options]