Navigation
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.
  • API >
  • Public API Resources

Public API Resources

The Ops Manager API exposes the following resources:

Root

Name Description
Root The starting point for the Ops 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.
Global Alerts Retrieves and acknowledges global alerts.
Global Alert Configurations Retrieves and edits alert configurations for global alerts.
Global Events Retrieves global 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 Ops Manager Performance Advisor.
Third-Party Integration Settings Integrate Ops Manager with third-party monitoring services to receive alerts.

Projects and Users

Note

Groups and projects are synonymous terms. Your {PROJECT-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.

Name Description
Projects Retrieves and edits projects and project membership.
Users Retrieves and edits users and their roles.
Access List Retrieves and edits addresses on a user’s access list.

Programmatic API Keys

Name Description
Organization Programmatic API Keys Retrieves and manages programmatic API keys for Organizations.
Organization Programmatic API Key Access Lists Retrieves and edits addresses on an Organization programmatic API key’s access list.
Organization API Keys on Projects Retrieves and assigns Organization programmatic API keys to Projects.
Global Programmatic API Keys Retrieves and manages global programmatic API keys.
Global Programmatic API Key Access List Retrieves and edits addresses on a global programmatic API key’s access list.

Organizations and Teams

Name Description
Organizations Creates, retrieves and deletes organizations.
Teams Retrieves teams.

Backup and Restore

Name Description
Backup Configurations Retrieves and edits the settings used to back up MongoDB.
Snapshot Schedule Retrieves and edits how often Ops Manager captures snapshots and how long Ops 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 Retrieve and update the project’s automation configuration, which defines the deployment’s MongoDB processes and agents. Available only on Automated deployments.
Get Automation Status of Latest Plan View the status of the latest automation configuration. Available only on Automated deployments.
Get Automation Status of Last 50 Plans View the status of the 50 most recent automation configurations. Available only on Automated deployments.

Version Manifest

Name Description
Version Manifest Retrieve or update the Version Manifest.

Log Collection Jobs

Name Description
Log Collection Jobs Retrieves and creates Ops Manager log collection jobs. Can also download Ops Manager deployment logs.

Diagnostics Archive

Name Description
Diagnostic Archives Manage the project’s diagnostics archive file.

Administration

Feature Control Policies

Name Description
Feature Control Policies Retrieves and manages feature control policies that external systems use.

Backup

Name Description
Blockstore Configurations Retrieves, updates, and removes blockstores.
File System Store Configurations Retrieves, updates, and removes file system stores.
S3 Blockstore Configurations Retrieves, updates, and removes S3 blockstores.
Oplog Store Configurations Retrieves, updates, and removes oplog stores.
S3 Oplog Configurations Manage Oplog configurations stored in S3.
Sync Store Configurations Retrieves, updates, and removes sync stores.
Backup Daemon Configurations Retrieves, updates, and removes Backup Daemons.
Backup Group Configurations Retrieves, updates, and removes backup groups.
Backup Encryption Keys Rotates KMIP master key and retrieves master key ID.

Live Migration from Ops Manager to MongoDB Atlas

Name Description
Live Data Migration from Ops Manager to MongoDB Atlas Connects an Ops Manager organization to an MongoDB Atlas organization. This connection allows you to migrate your data from a deployment in Ops Manager to a target cluster in Atlas.