Return All MongoDB Processes in One Project
Returns details of all processes for the specified project. A MongoDB process can be either a mongod
or mongos
. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
Path parameters
-
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
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. The resource and corresponding endpoints use the term groups.
Format should match the following pattern:
^([a-f0-9]{24})$
.
Query parameters
-
Flag that indicates whether Application wraps the response in an
envelope
JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.Default value is
false
. -
Flag that indicates whether the response returns the total number of items (totalCount) in the response.
Default value is
true
. -
Number of items that the response returns per page.
Minimum value is
1
, maximum value is500
. Default value is100
. -
Number of the page that displays the current set of the total objects that the response returns.
Minimum value is
1
. Default value is1
. -
Flag that indicates whether the response body should be in the prettyprint format.
Default value is
false
.Prettyprint
atlas api monitoringAndLogs listGroupProcesses --help
import ( "os" "context" "log" sdk "go.mongodb.org/atlas-sdk/v20250312001/admin" ) func main() { ctx := context.Background() clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID") clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET") // See https://dochub.mongodb.org/core/atlas-go-sdk-oauth client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret)) if err != nil { log.Fatalf("Error: %v", err) } params = &sdk.ListGroupProcessesApiParams{} sdkResp, httpResp, err := client.MonitoringandLogsApi. ListGroupProcessesWithParams(ctx, params). Execute() }
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-03-12+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest --include \ --header "Accept: application/vnd.atlas.2025-03-12+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true"
{ "links": [ { "href": "https://cloud.mongodb.com/api/atlas", "rel": "self" } ], "results": [ { "created": "2025-05-04T09:42:00Z", "groupId": "32b6e34b3d91647abb20e7b8", "hostname": "string", "id": "string", "lastPing": "2025-05-04T09:42:00Z", "links": [ { "href": "https://cloud.mongodb.com/api/atlas", "rel": "self" } ], "port": 42, "replicaSetName": "string", "shardName": "string", "typeName": "REPLICA_PRIMARY", "userAlias": "string", "version": "string" } ], "totalCount": 42 }
{ "error": 401, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Unauthorized", "errorCode": "NOT_ORG_GROUP_CREATOR" }
{ "error": 403, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Forbidden", "errorCode": "CANNOT_CHANGE_GROUP_NAME" }
{ "error": 404, "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", "reason": "Not Found", "errorCode": "RESOURCE_NOT_FOUND" }
{ "error": 500, "detail": "(This is just an example, the exception may not be related to this endpoint)", "reason": "Internal Server Error", "errorCode": "UNEXPECTED_ERROR" }