Navigation
You were redirected from a different version of the documentation. Click here to go back.

Get All Projects for the Current User

On this page

Note

Groups and projects are synonymous terms. Your {PROJECT-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/api/public/v1.0

Resource

copy 
GET /groups

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

The following query parameters are optional:

Name Type Necessity Description Default
pageNum number Optional One-based integer that returns a subsection of results. 1
itemsPerPage number Optional Number of items to return per page, up to a maximum of 500. 100
pretty boolean Optional Flag that indicates whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag that 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 a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

 false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name Type Description
results array Array includes one object for each item detailed in the results Embedded Document section.
links array Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Each result is one project.

Name Type Description
activeAgentCount integer

Number of active agents 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.
hostCounts object Total number of hosts by type. The embedded fields should be self-explanatory.
id string Unique identifier for the group.
lastActiveAgent string Time Cloud Manager last updated the activeAgentCount total for the project. Cloud Manager refreshes this value every 24 hours and caches it to record the number of active MongoDB Agents.
links object array One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.
name string Display name for the project.
orgId string Unique identifier for the organization to which the project belongs.
publicApiEnabled boolean Flag indicating that the API is enabled for this project. This is a read-only field that is always true.
replicaSetCount integer Total number of replica sets for this project.
shardCount integer Total number of shards for this project.

Example Request

copy 
1
2
3
4
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups?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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

copy 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
{
  "links": [{
    "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100",
    "rel": "self"
  }, {
    "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2",
    "rel": "next"
  }],
  "results": [{
    "activeAgentCount": 0,
    "hostCounts": {
      "arbiter": 0,
      "config": 0,
      "master": 0,
      "mongos": 0,
      "primary": 0,
      "secondary": 0,
      "slave": 0
    },
    "id": "56a10a80e4b0fd3b9a9bb0c2",
    "lastActiveAgent": "2016-03-09T18:19:37Z",
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
      "rel": "self"
    }],
    "name": "012i3091203jioawjioej",
    "orgId": "5980cfdf0b6d97029d82f86e",
    "publicApiEnabled": true,
    "replicaSetCount": 0,
    "shardCount": 0,
    "tags": []
  }, {
    "activeAgentCount": 0,
    "hostCounts": {
      "arbiter": 0,
      "config": 0,
      "master": 0,
      "mongos": 0,
      "primary": 0,
      "secondary": 0,
      "slave": 0
    },
    "id": "56aa691ce4b0a0e8c4be51f7",
    "lastActiveAgent": "2016-01-29T19:02:56Z",
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
      "rel": "self"
    }],
    "name": "1454008603036",
    "orgId": "5980d0040b6d97029d831798",
    "publicApiEnabled": true,
    "replicaSetCount": 0,
    "shardCount": 0,
    "tags": []
  }, {
    "activeAgentCount": 0,
    "hostCounts": {
      "arbiter": 0,
      "config": 0,
      "master": 0,
      "mongos": 0,
      "primary": 0,
      "secondary": 0,
      "slave": 0
    },
    "id": "56aa6dfde4b0fe328eee82ad",
    "lastActiveAgent": "2016-01-29T20:34:28Z",
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
      "rel": "self"
    }],
    "name": "1454009852809",
    "orgId": "5980d0040b6d97029d831799",
    "publicApiEnabled": true,
    "replicaSetCount": 0,
    "shardCount": 0,
    "tags": []
  }, {
    "activeAgentCount": 0,
    "hostCounts": {
      "arbiter": 0,
      "config": 0,
      "master": 0,
      "mongos": 0,
      "primary": 0,
      "secondary": 0,
      "slave": 0
    },
    "id": "56aa8421e4b0d04c1c54df99",
    "lastActiveAgent": "2016-01-29T21:36:10Z",
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
      "rel": "self"
    }],
    "name": "1454015520776",
    "orgId": "5980d0040b6d97029d83179a",
    "publicApiEnabled": true,
    "replicaSetCount": 0,
    "shardCount": 0,
    "tags": []
  }, {
    "activeAgentCount": 0,
    "hostCounts": {
      "arbiter": 0,
      "config": 0,
      "master": 0,
      "mongos": 0,
      "primary": 0,
      "secondary": 0,
      "slave": 0
    },
    "id": "56aa85f9e4b0d04c1c54e347",
    "lastActiveAgent": "2016-01-29T21:36:10Z",
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
      "rel": "self"
    }],
    "name": "1454015992252",
    "orgId": "5980d0040b6d97029d83179b",
    "publicApiEnabled": true,
    "replicaSetCount": 0,
    "shardCount": 0,
    "tags": []
  }],
  "totalCount": 5
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.