Docs Home → MongoDB Ops Manager
Root
On this page
The root resource is the starting point for the Ops Manager API. From
here, you can traverse the links to reach all other API resources.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /
Request Path Parameters
This endpoint doesn't 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 For endpoints that return a list of results, the | false |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
The response includes:
Name | Type | Description |
|---|---|---|
appName | string | MongoDB Ops Manager |
build | string | The SHA that corresponds to the GitHub commit for the Ops Manager. |
links | object array | One or more links to sub-resources and/or related resources. All
|
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 "<ops-manager-host>:<port>/api/public/v1.0"
Example Response
{ "appName" : "MongoDB Ops Manager", "build" : "ec8b09b880be314981caa9d8fbefc3280056522e", "links" : [ ], "throttling" : false }