Navigation

Root

The root resource is the starting point for the Atlas API.

Syntax

GET https://cloud.mongodb.com/api/atlas/v1.0/

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 Atlas API resources. These are all optional.

Name Type Description Default
pretty boolean Display response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

The response includes the following elements:

Field Description
appName MongoDB Cloud
build The SHA that corresponds to the GitHub commit for the Atlas.
links Array of links to related API resources. For more information on links, see Linking.
throttling Obsolete field. Always false.

Example

Example Request

curl -X GET -u "username:apiKey" --digest "https://cloud.mongodb.com/api/atlas/v1.0"

Example Response

{
   "appName": "MongoDB Cloud",
   "build": "ec8b09b880be314981caa9d8fbefc3280056522e",
   "links": [
      {
         "href": "https://cloud.mongodb.com/api/atlas/v1.0",
         "rel": "self"
      },
      {
         "href": "https://cloud.mongodb.com/api/atlas/v1.0/users/5555320d3bf9942ef124958b",
         "rel": "http://mms.mongodb.com/user"
      }
   ],
   "throttling": false
}