Agents

Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.

OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.: The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.

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.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Endpoints

Agents

The following endpoints are available for Agents:

Method	Endpoint	Description
GET	/groups/{PROJECT-ID}/agents	Return list of links to Agent resources in one Cloud Manager project.
GET	/groups/{PROJECT-ID}/agents/{TYPE}	Return list of Agents of a specified type in one Cloud Manager project.

Agents API Keys

The following endpoints are available for Agent API Keys:

Method	Endpoint	Description
POST	/groups/{PROJECT-ID}/agentapikeys	Create one Agent API Key in one Cloud Manager project.
GET	/groups/{PROJECT-ID}/agentapikeys	Return list of all Agent API Keys in one Cloud Manager project.
DELETE	/groups/{PROJECT-ID}/agentapikeys/{API-AGENT-KEY-ID}	Remove one Agent API Key in one Cloud Manager project.

Back

Update One

Get Links