Navigation
You were redirected from a different version of the documentation. Click here to go back.

Root

The root resource is the starting point for the Cloud Manager API. From here, you can traverse the links to reach all other API resources.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

The following query parameters are optional:

Name Type Necessity Description Default
pageNum number Optional One-based integer that returns a subsection of results. 1
itemsPerPage number Optional Number of items to return per page, up to a maximum of 500. 100
pretty boolean Optional Flag that indicates whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope : true in the query.

For endpoints that return a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

The response includes:

Name Type Description
appName string MongoDB Cloud
build string The SHA that corresponds to the GitHub commit for the Cloud Manager.
links object array One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.
throttling boolean The field is obsolete and has the value false.

Example Request

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0"

Example Response

{
   "appName" : "MongoDB Cloud",
   "build" : "ec8b09b880be314981caa9d8fbefc3280056522e",
   "links" : [

   ],
   "throttling" : false
}