Navigation

Get Agents by Type for a Group

Get all agents of a specified type (i.e. Monitoring, Backup, or Automation) for a group.

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://cloud.mongodb.com/

Syntax

GET /api/public/v1.0/groups/{GROUP-ID}/agents/{TYPE}

Where {TYPE} can be one of the following values:

  • MONITORING
  • BACKUP
  • AUTOMATION

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

Field Required/Optional Description
pageNum Optional. The page to return.
itemsPerPage Optional. Maximum number of items to return per page. Default is 100.
envelope Optional. A boolean that specifies whether or not to wrap the response in an envelope.

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Name Type Description
typeName string The type of agent: MONITORING, BACKUP, or AUTOMATION.
hostname string Primary hostname. A host typically may have aliases, so the primary is the best available name as decided by Cloud Manager.
confCount number Number of configuration calls.
lastConf timestamp Date and time of last configuration call.
stateName string

The current state of the agent. stateName can return the following values:

  • ACTIVE: the agent is active and operating
  • STANDBY: the agent is on standby
  • NO_PROCESSES: the agent is not managing, monitoring, or backing up any processes.
pingCount number Only applicable to Monitoring agents. The number of pings that the Monitoring agent has sent to the hostname URL.
isManaged Boolean Only applicable to Monitoring and Backup agents. Specifies whether or not Cloud Manager manages the agent.
lastPing timestamp Only applicable to Monitoring agents. Time of most recent ping.
tag string Only applicable to Backup agents. The agent’s tag, if there is one.

Examples

Get All Monitoring Agents for a Group

Request

curl -u "username:apiKey" --digest -i "https://cloud.mongodb.com/api/public/v1.0/groups/5421e044e4b09da19248b17f/agents/MONITORING"

Response

HTTP/1.1 200 OK

{
  "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
}

Get All Backup Agents for a Group

Request

curl -u "username:apiKey" --digest -i "https://cloud.mongodb.com/api/public/v1.0/groups/5421e044e4b09da19248b17f/agents/BACKUP"

Response

HTTP/1.1 200 OK

{
  "links": [ ... ],
  "results": [
    {
      "confCount": 12,
      "hostname": "example",
      "isManaged": true,
      "lastConf": "2015-06-18T14:26:29Z",
      "stateName": "ACTIVE",
      "typeName": "BACKUP"
    }
  ],
  "totalCount": 1
}

Get All Automation Agents for a Group

Request

curl -u "username:apiKey" --digest "https://cloud.mongodb.com/api/public/v1.0/groups/5421e044e4b09da19248b17f/agents/AUTOMATION"

Response

{
  "links": [ ... ],
  "results": [
    {
      "confCount": 141,
      "hostname": "example-1",
      "lastConf": "2015-06-18T14:27:42Z",
      "stateName": "ACTIVE",
      "typeName": "AUTOMATION"
    }
  ],
  "totalCount": 1
}