From 86b7d5acead01579ca7c25b72c087d4b2f9d8a22 Mon Sep 17 00:00:00 2001 From: Pablo Alberto Camino Date: Mon, 12 Aug 2024 15:14:52 -0300 Subject: [PATCH 1/2] Clarify {domain} meaning and link Exchange spec --- cloudhub/modules/ROOT/pages/cloudhub-api.adoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/cloudhub/modules/ROOT/pages/cloudhub-api.adoc b/cloudhub/modules/ROOT/pages/cloudhub-api.adoc index 4f3075145..0426a0a5f 100644 --- a/cloudhub/modules/ROOT/pages/cloudhub-api.adoc +++ b/cloudhub/modules/ROOT/pages/cloudhub-api.adoc @@ -63,6 +63,7 @@ Before getting started, familiarize yourself with operations for applications. You can use any HTTP client with the CloudHub API. With Java, use the https://jersey.github.io/[Jersey client] or http://hc.apache.org/httpclient-3.x/index.html[HttpClient] with https://github.com/codehaus/jackson[Jackson] for JSON support. +The CloudHub API specification is pulished in https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/minor/1.0/pages/home/[MuleSoft's developer portal]. After going through this quick start guide refer to this resource for more details. To access operations in the CloudHub API, you must: @@ -130,7 +131,22 @@ Here is an example of data received in JSON format in response to a request to g } ---- +=== The `{domain}` parameter +For most of the API calls that deal with a single application you will be requested to provide its domain, for example when requesting application details: + `https://anypoint.mulesoft.com/cloudhub/api/v2/applications/{domain}` + +This domain is the uniquie application name, part of the full fomain that will be used to cosume your application. +If you are not sure what is the domain value for a particular application follow the link:#get-a-list-of-applications[example] above to retrieve application list and refer to the `domain` field in the output. + +[source,json,linenums] +---- +{ + "versionId": "xxxxxxxx", + "domain": "hello", + ... +} +---- == Rate Limits From 67fcc7afbec7f04c3df630677775c083748d1de6 Mon Sep 17 00:00:00 2001 From: Pablo Alberto Camino Date: Mon, 12 Aug 2024 15:27:08 -0300 Subject: [PATCH 2/2] Linked API section from main FAQ --- cloudhub/modules/ROOT/pages/cloudhub-faq.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/cloudhub/modules/ROOT/pages/cloudhub-faq.adoc b/cloudhub/modules/ROOT/pages/cloudhub-faq.adoc index 3ee3e5af8..70841bfb1 100644 --- a/cloudhub/modules/ROOT/pages/cloudhub-faq.adoc +++ b/cloudhub/modules/ROOT/pages/cloudhub-faq.adoc @@ -202,6 +202,10 @@ The CloudHub platform is monitored 24 hours a day, 7 days a week, by automated s No. include::partial$heap-dump-note.adoc[] +== Can I manage my CloudHub settings and deployments programaticallly? + +Yes, there is a CloudHub API available. Refer to link:cloudhub-api.adoc[CloudHub API] for a quick start and https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/minor/1.0/pages/home/[MuleSoft's developer portal^] for the complete reference. + == See Also * xref:runtime-manager::managing-deployed-applications.adoc[Manage Deployed Applications] @@ -220,3 +224,4 @@ include::partial$heap-dump-note.adoc[] * xref:secure-application-properties.adoc[Safely Hide Application Properties] * xref:virtual-private-cloud.adoc[Anypoint Virtual Private Cloud] * xref:penetration-testing-policies.adoc[Penetration Testing Policies] +* xref:cloudhub-api.adoc[CloudHub API]