Navigation
This version of the documentation is archived and no longer supported. It will be removed on EOL_DATE. 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.
This version of the manual is no longer supported. It will be removed on EOL_DATE.

Agents

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.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Endpoints

The following endpoints are available for agents:

Method Endpoint Description
GET /groups/{GROUP-ID}/agents Get links to Monitoring, Backup, and Automation agent resources for a project.
GET /groups/{GROUP-ID}/agents/{TYPE} Get agents of a specified type (Monitoring, Backup, or Automation) for a project.
POST /groups/{GROUP-ID}/agentapikeys Create one Agent API Key for a project.
GET /groups/{GROUP-ID}/agentapikeys Get list of all Agent API Keys for one project.
DELETE /groups/{GROUP-ID}/agentapikeys/{API-AGENT-KEY-ID} Get agents of a specified type (Monitoring, Backup, or Automation) for a group.