Navigation

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

This endpoint may use any of the HTTP request query parameters available to all Cloud Manager API resources. These are all optional.

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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. The relations between URLs are explained in the Web Linking Specification
throttling boolean The field is obsolete and has the value false.

Example Request

curl --user '{USERNAME}:{APIKEY}' --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
}