Get All MongoDB Processes in a Group


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. The resource and corresponding endpoints use the term groups.

Get all Atlas MongoDB processes for the specified project. An Atlas MongoDB process can be either a mongod or a mongos.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

Base URL:


GET api/atlas/v1.0/groups/{GROUP-ID}/processes

Request Path Parameters

Path Element Required/Optional Description
GROUP-ID Required. The unique identifier for the project whose MongoDB processes you want to retrieve.

Request Query Parameters

Field Required/Optional Description
pageNum Optional.

The page to return.

Defaults to 1.

itemsPerPage Optional.

Number of items to return per page, up to a maximum of 500.

Defaults to 100.

includeCount Optional.

A boolean that specifies whether or not to include the totalCount field in the response.

Defaults to true.

envelope Optional.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.

pretty Optional.

A boolean that specifies whether or not to return a “pretty-printed” JSON document.

Defaults to false.

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

If you set the query element envelope to true, the response is wrapped by a content object.

The HTTP response returns a JSON document that includes the following objects:

An array of documents representing a link to one or more sub-resources and/or related resources such as list pagination. See Linking for more information.

An array of documents, each representing one Atlas MongoDB process within your Atlas project.

Name Type Description
created DateTime Date this Atlas MongoDB process was created by Atlas.
groupId string ID of the project that owns the Atlas MongoDB process.
hostname string The hostname of the machine running the Atlas MongoDB process.
id string The hostname and port of the Atlas MongoDB process in hostname:port format.
lastPing DateTime When the last ping for this Atlas MongoDB process was received.
links array of objects One or more links to sub-resources and/or related resources.
port number The port to which the Atlas MongoDB process listens.
shardName string Name of the shard this process belongs to. Only present if this process is part of a sharded cluster.
replicaSetName string Name of the replica set this process belongs to. Only present if this process is part of a replica set.
typeName string

Type for this Atlas MongoDB process. Possible values are:


The type for new processes added to Atlas will be NO_DATA until Atlas completes deployment of the process.

userAlias string User-friendly hostname of the cluster node. The user-friendly hostname is typically the standard hostname for a cluster node and it appears in the connection string for a cluster instead of the value of the hostname field.
version string Version of MongoDB running for this process.
The total number of items in the result set. This value may be higher than the number of objects in the results array if the entire result set is paginated.

Example Request


You must modify the following code block with the appropriate credentials and project ID.

curl -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest "{GROUP-ID}/processes?pretty=true"

Example Response

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: Tue, 22 Aug 2017 21:36:28 GMT
Connection: keep-alive
Content-Length: 3742

  "links" : [ ... ],
  "results" : [ {
    "created" : "2020-08-25T18:44:13Z",
    "groupId" : "12345678",
    "hostname" : "",
    "id" : "",
    "lastPing" : "2020-09-01T18:40:06Z",
    "links" : [ ... ],
    "port" : 27017,
    "replicaSetName" : "atlas-abcdef-shard-0",
    "typeName" : "REPLICA_PRIMARY",
    "userAlias" : ""
    "version" : "3.6.7"
  "totalCount" : 6