- API >
- API Resources >
- Root
Root¶
On this page
The root resource is the starting point for the Atlas API.
Base URL: https://cloud.mongodb.com/
Syntax¶
GET /api/atlas/v1.0/
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
Request Query Parameters¶
| Field | Required/Optional | Description |
|---|---|---|
pageNum |
Optional. | The page to return. |
itemsPerPage |
Optional. | Maximum number of items to return per page. Default is 100. |
envelope |
Optional. | A boolean that specifies whether or not to wrap the response in an envelope. |
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 |
The field is obsolete and has the value 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
}