Root¶

On this page

Sample Entity
Entity Fields
Links
Example

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¶

copy

{
  "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.

Links¶

Relation	Description
self	Me
groups	Groups accessible to the current API user.
user	The current API user.

Example¶

Retrieve the root resource:

copy

curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0"

copy

HTTP/1.1 200 OK

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

← Public API Resources Hosts →