Skip to content

W-16475594 – Clarified {domain} parameter and made API Exchange spec available from documentation #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: latest
Choose a base branch
from
Open

W-16475594 – Clarified {domain} parameter and made API Exchange spec available from documentation #744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86b7d5a
Clarify {domain} meaning and link Exchange spec
PabloCamino Aug 12, 2024
67fcc7a
Linked API section from main FAQ
PabloCamino Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions cloudhub/modules/ROOT/pages/cloudhub-api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions cloudhub/modules/ROOT/pages/cloudhub-faq.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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]