Navigation

Get One Group by Name

Base URL: https://cloud.mongodb.com/

Syntax

GET /api/public/v1.0/groups/byName/{GROUP-NAME}

Request Parameters

Request Path Parameters

Parameter Required/Optional Description
GROUP-NAME Required. The name of the group.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Cloud Manager API resources. These are all optional.

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Display response in a prettyprint format. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Name Type Description
id string The unique identifier for the group.
name string The display name for the group.
hostCounts object The total number of hosts by type. The embedded fields should be self-explanatory.
lastActiveAgent date The time Cloud Manager last updated the activeAgentCount total for the group. Cloud Manager runs a job every 30 minutes to record the number of active agents of any type (Monitoring, Backup, Automation).
activeAgentCount number

The number of active agents of any type (Monitoring, Backup, Automation) sending regular pings to Cloud Manager.

The value is refreshed every 30 minutes. If you start a new agent or stop an existing one, the change can take up to 30 minutes to show up in the activeAgentCount field.

replicaSetCount number The total number of replica sets for this group.
shardCount number The total number of shards for this group.
publicApiEnabled boolean The indicator that the Public API is enabled for this group. This is a read-only field that is always true.
agentApiKey string

The agent API key for the group.

You must have the Owner role to view this field.

links string array See Response Links.

Response Links

Relation Description
self Me.
http://cloud.mongodb.com/hosts All hosts for the group.
http://cloud.mongodb.com/users All users for the group.
http://cloud.mongodb.com/clusters All clusters for the group.
http://cloud.mongodb.com/alertConfigs All alertConfigs for the group.
http://cloud.mongodb.com/alerts All alerts for the group.
http://cloud.mongodb.com/backupConfigs All backup configs for the group.
http://cloud.mongodb.com/agents All agents for the group.
http://cloud.mongodb.com/sshKeys All ssh keys for the group.
http://cloud.mongodb.com/providerConfigs All provider configs for the group.
http://cloud.mongodb.com/machineConfigOptions All machine config options for the group.
http://cloud.mongodb.com/provisionedMachines All provisioned machines for the group.
http://cloud.mongodb.com/provisionMachineJobs All provision machine jobs for the group.

Examples

Example Request

curl --user "{username}:{apiKey}" --digest \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/{GROUP-NAME}?pretty=true"

Important

Some characters are not allowed in URLs. These are called reserved characters. If your {GROUP-NAME} includes reserved characters, like spaces, you must replace them with their percent encoding.

Example

Instead of making this request (via curl):

curl --user "{username}:{apiKey}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My Group?pretty=true"

Make this request (via curl):

curl --user "{username}:{apiKey}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Group?pretty=true"

Example Response

Response Header

HTTP/1.1 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
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

{
  "activeAgentCount": 1,
  "agentApiKey": "{AGENT-API-KEY}",
  "hostCounts": {
    "arbiter": 2,
    "config": 1,
    "primary": 4,
    "secondary": 8,
    "mongos": 2,
    "master": 0,
    "slave": 0
  },
  "id": "{GROUP-ID}",
  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
  "links": [ ... ],
  "name": "My Group",
  "publicApiEnabled": true,
  "replicaSetCount": 3,
  "shardCount": 2,
}