Navigation
  • API >
  • Public API Resources

Public API Resources

The Ops 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 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.

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 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.
Backup Encryption Keys Rotates KMIP master key and retrieves master key ID.
Restore Jobs Retrieves and creates requests to restore your data to a previous state.
S3 Oplog Configurations Manage Oplog configurations stored in S3.

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.

Server Pool

Name Description
Server Pool Retrieves the status of the server pool and provides root access to the server pool API resources.
Server Pool Servers Retrieves the pool’s servers.
Server Pool Requests Retrieves and updates provisioning requests.
Server Pool Properties Retrieves and edits the properties and values available to assign to servers.
Group Server Pool Retrieves the status of the server pool and provides root access to the project’s server pool API resources.
Group Server Pool Servers Retrieves the servers from the pool currently in use by the project.
Group Server Pool Requests Retrieves and updates the project’s provisioning requests to the pool.
Group Server Pool Properties Retrieves properties assigned to servers in the project’s pool.

Administration

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