Get Agents by Type for One Project
On this page
- 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.
Get all agents of a specified type (i.e. Monitoring, Backup, or Automation) for a project.
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
Resource
GET /groups/{PROJECT-ID}/agents/{TYPE}
Request Path Parameters
Name | Type | Description |
---|---|---|
PROJECT-ID | string | Unique identifier of the project that owns the Agent API Key. |
TYPE | string | The agent type to retrieve. TYPE can be one of the following values:
|
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. |
|
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. |
|
pretty | boolean | Optional | Flag that indicates whether the response body should be in a prettyprint format. |
|
envelope | boolean | Optional | Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return a list of results, the |
|
backupJobsEnabledOnly | boolean | Optional | Flag indicating whether to exclude daemons not enabled for
backing up databases from the response. Set this to |
|
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
---|---|---|
| string | The type of agent: |
| string | Primary hostname. A host typically may have aliases, so the primary is the best available name as decided by Cloud Manager. |
| number | Number of configuration calls. |
| timestamp | Date and time of last configuration call. |
| string | The current state of the agent.
|
| number | Only applicable to Monitoring Agents. The number of pings that
the Monitoring Agent has sent to the |
| Boolean | Only applicable to Monitoring and Backup Agents. Specifies whether or not Cloud Manager manages the agent. |
| timestamp | Only applicable to Monitoring Agents. Time of most recent ping. |
| string | Only applicable to Backup Agents. The agent's tag, if there is one. |
Example Request
Get All Monitoring Agents for One Project.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/MONITORING"
Example Response
Response Header
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Response Body
{ "links" : [], "results": [ { "confCount": 59, "hostname": "example", "isManaged": true, "lastConf": "2015-06-18T14:21:42Z", "lastPing": "2015-06-18T14:21:42Z", "pingCount": 6, "stateName": "ACTIVE", "typeName": "MONITORING" } ], "totalCount": 1 }