• API >
• Public API Resources

Public API Resources

The Cloud Manager API exposes the following resources:

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.

• Root

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.

• Deployments

Agents

Name	Description
Agents	Retrieves Agents.

• Agents
  • Endpoints
    • Agents
    • Agents API Keys
      • Get Links to Agent Resources for a Project
        • Resource
          • Request Path Parameters
          • Request Query Parameters
          • Request Body Parameters
        • Response
        • Example
          • Request
          • Response
          • Response Header
          • Response Body
      • Get Agents by Type for One Project
        • Resource
          • Request Path Parameters
          • Request Query Parameters
          • Request Body Parameters
        • Response
        • Example Request
        • Example Response
          • Response Header
          • Response Body
      • Create One Agent API Key
        • Resource
          • Request Path Parameters
          • Request Query Parameters
          • Request Body Parameters
        • Response
        • Example Request
        • Example Response
          • Response Header
          • Response Body
      • Get All Agent API Keys for One Project
        • Resource
          • Request Path Parameters
          • Request Query Parameters
          • Request Body Parameters
        • Response
        • Example Request
        • Example Response
          • Response Header
          • Response Body
      • Remove One Agent API Key
        • Resource
          • Request Path Parameters
          • Request Query Parameters
          • Request Body Parameters
        • Response
        • Example Request
        • Example Response
          • Response Header
          • Response Body

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.
Third-Party Integration Settings	Integrate Cloud Manager with third-party monitoring services to receive alerts.

• Measurements and 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.
Whitelist (Deprecated)	Retrieves and edits addresses on a user’s whitelist.

• Projects and Users

Programmatic API Keys

Name	Description
Organization Programmatic API Keys	Retrieves and manages programmatic API keys for Organizations.
Organization Programmatic API Key Whitelists	Retrieves and edits addresses on an Organization programmatic API key’s whitelist.
Organization API Keys on Projects	Retrieves and assigns Organization programmatic API keys to Projects.

• Programmatic API Keys

Organizations and Teams

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

• Organizations and Teams

Invoices

Name	Description
Invoices	Retrieve invoices.

• Invoices
  • Get All Invoices for One Organization
  • Get One Organization Invoice
  • Get Pending Invoice 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.

• Backup and Restore

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.

• Automation

Log Collection Jobs

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

• Log Collection Jobs
  • Get All Log Collection Jobs for One Project
  • Get One Log Collection Job
  • Download Logs from a Log Collection Job
  • Create a Log Collection Job
  • Extend a Log Collection Job
  • Retry a Failed Log Collection Job
  • Delete a Log Collection Job

Feature Control Policies

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

• Feature Control Policies
  • Retrieve Feature Policies for One Project
  • Update Feature Policies for One Project
  • Retrieve All Feature Policies

Live Migration from Cloud Manager to MongoDB Atlas

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

• Live Data Migration from Cloud Manager to MongoDB Atlas
  • Connect One Organization with One Atlas Organization
  • Remove the Connection between Organizations
  • Return the Status of the Connection between Organizations

←   Public API Principles Root  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.