This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.


This is the starting point (or the homepage, if you will) for the Ops Manager API. From here, you can traverse the links to reach all other API resources.

Sample Entity

  "throttling": false,
  "links": [ ... ]

Entity Fields

Name Type Description
throttling boolean Tells whether or not Ops Manager is throttling data. This can be used as a simple indicator of the current health of Ops Manager, since throttling is generally enabled when Ops Manager is in an unhealthy state.


Retrieve the root resource:

curl -u "username:apiKey" --digest -i ""
HTTP/1.1 200 OK

  "throttling" : false,
  "links" : [ ... ]