Get a Group by Name


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:


GET /groups/byName/{GROUP-NAME}

Request Parameters

Request Path Parameters

Name Type Description
GROUP-NAME string (Required.) The name of the group.

Request Query Parameters

The following query parameters are optional:

Name Type Description Default
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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 envelope=true in the query.

For endpoints that return one result, the response body includes:

HTTP response code
The expected response body

Request Body Parameters

This endpoint does not use HTTP request body parameters.


Name Type Description
activeAgentCount number

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

The value is refreshed about every 24 hours and cached. 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.

agentApiKey string

Agent API key for the group.

You must have the Owner access for the group.

hostCounts object Total number of hosts by type. The embedded fields should be self-explanatory.
id string Unique identifier for the group.
lastActiveAgent date Time Cloud Manager last updated the activeAgentCount total for the group. Cloud Manager refreshes this value every 24 hours and caches it to record the number of active agents of any type (Monitoring, Backup, Automation).
links object array One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification
name string Display name for the group.
orgId string Unique identifier for the organization to which the group/project belongs.
publicApiEnabled boolean Indicator that the Public API is enabled for this group. This is a read-only field that is always true.
replicaSetCount number Total number of replica sets for this group.
shardCount number Total number of shards for this group.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --include \
 --request GET "{GROUP-NAME}?pretty=true"


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.


Instead of making this request (via curl):

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET " Group?pretty=true"

Make this request (via curl):

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET ""

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",
  "orgId" : "111111111cccccf38dc78bdf",
  "publicApiEnabled": true,
  "replicaSetCount": 3,
  "shardCount": 2,