Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

Get All Projects in an Organization

On this page

  • Resource
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Response Document
  • results Embedded Document
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}/groups
Path Element
Type
Description
ORG-ID
Required.
The unique identifier for the organization whose information you want to retrieve.

The following query parameters are optional:

Name
Type
Description
Default
pageNum
integer
Page number (1-based).
1
itemsPerPage
integer
Number of items to return per page, up to a maximum of 500.
100
pretty
boolean
Displays response in a prettyprint format.
false
envelope
boolean
Specifies whether or not to wrap the response in an envelope.
false
name
string

Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project, which is prefixed by the specified name, within the organization.

Example

If you specify a name query parameter of project1, Ops Manager returns the project named project1, but would not return a project named project123.

None

This endpoint doesn't use HTTP request body parameters.

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.

Each result is one project.

Name
Type
Description
activeAgentCount
integer
The number of active monitoring, automation, and Backups in the project.
hostCounts
Document
Describes the host types and number of each host type for the cluster.
hostCounts.arbiter
integer
The number of arbiter hosts in the cluster.
hostCounts.config
integer
The number of sharded cluster configuration server hosts in the cluster.
hostCounts.mongos
integer
The number of mongos hosts in the cluster.
hostCounts.primary
integer
The number of primary hosts in the cluster.
hostCounts.secondary
integer
The number of secondary hosts in the cluster.
id
string
The unique identifier for the project.
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
The name of the cluster.
orgId
string
The unique identifier for the parent organization of the project.
publicApiEnabled
boolean
The status of API access to the cluster.
replicaSetCount
integer
The number of replica sets in the cluster.
shardCount
integer
The number of shards in the cluster.
curl --user "{username:apiKey}" \
--include \
--header "Content-Type: application/json" \
--digest GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/groups"
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}
{
"links": [
{
}
],
"results": [
{
"activeAgentCount": 0,
"hostCounts": {
"arbiter": 0,
"config": 0,
"mongos": 0,
"primary": 1,
"secondary": 2
},
"id": "{PROJECT-ID}",
"links": [
{
}
],
"name": "Production Cluster",
"orgId": "{ORG-ID}",
"publicApiEnabled": true,
"replicaSetCount": 1,
"shardCount": 0
},
{
"activeAgentCount": 0,
"hostCounts": {
"arbiter": 0,
"config": 0,
"mongos": 0,
"primary": 1,
"secondary": 2
},
"id": "{PROJECT-ID}",
"lastActiveAgent": "2017-10-26T02:39:59Z",
"links": [
{
}
],
"name": "Staging Cluster",
"orgId": "{ORG-ID}",
"publicApiEnabled": true,
"replicaSetCount": 1,
"shardCount": 0
}
],
"totalCount": 2
}

Back

Get One Organization

Next

Get All Organization Users