Navigation
  • API >
  • Public API Resources

Public API Resources

The Cloud Manager Public API exposes the resources listed on this page.

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

Root

Name Description
Root The starting point for the Cloud Manager Public API. From here, you can traverse the links to reach all other API resources.

Deployments

Name Description
Hosts Retrieves and edits the MongoDB processes in your deployment.
Disks Retrieves the disks and disk partitions on which MongoDB runs. Available only on Automated deployments.
Databases Retrieves a host’s MongoDB databases.
Clusters Retrieves and edits the deployment’s replica sets and sharded clusters.

Measurements and Alerts

Name Description
Measurements Retrieves data points for your deployments.
Alerts Retrieves and acknowledges alerts.
Alert Configurations Retrieves and edits alert configurations, which define the conditions that trigger alerts and the methods of notification.
Events Retrieves organization and project events.
Maintenance Windows Turns off alert notifications for specified alert types for a period of time, to allow maintenance to occur.
Performance Advisor Monitor slow queries and get suggested indexes from the Cloud Manager Performance Advisor.

Groups and Users

Name Description
Projects Retrieves and edits projects and project membership.
Users Retrieves and edits users and their roles.
Whitelist Retrieves and edits addresses on a user’s whitelist.
User API Keys Manage user API keys.

Organizations and Teams

Name Description
Organizations Creates, retrieves, renames, and deletes organizations.
Teams Retrieves teams.
API Keys Creates, retrieves, and updates API keys for an organization.

Backup and Restore

Name Description
Backup Configurations Retrieves and edits the settings used to back up MongoDB.
Snapshot Schedule Retrieves and edits how often Cloud Manager captures snapshots and how long Cloud Manager retains them.
Snapshots Retrieves snapshot metadata and removes existing snapshots.
Checkpoints Retrieves checkpoint metadata.
Restore Jobs Retrieves and creates requests to restore your data to a previous state.

Automation

Name Description
Automation Configuration Retrieves and update the project’s automation configuration, which defines the deployment’s MongoDB processes and agents. Available only on Automated deployments.
Automation Status View the status of an updated automation configuration. Available only on Automated deployments.