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

Get All Projects with Specific Tags for the Current User

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

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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups

This endpoint doesn't use HTTP request path parameters.

Name
Type
Description
tag
string

The tags assigned to the project for use in programmatically identifying the project.

  • To view tags you must have the Project Read Only role.

  • To create or edit tags you must have the Project Automation Admin role.

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

Number of active agents sending regular pings to Ops 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 project.
lastActiveAgent
string
Time Ops Manager last updated the activeAgentCount total for the project. Ops Manager refreshes this value every 24 hours and caches it to record the number of active MongoDB Agents.
ldapGroupMappings
object array
For LDAP-backed Ops Manager, the mappings of LDAP groups to Ops Manager project roles. Only present for LDAP-backed Ops Manager.
ldapGroupMappings
.roleName
string

Ops Manager user role. The mapping of Project Role to roleName follows:

User Role
roleName Value
Project Owner (required)
GROUP_OWNER
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_MONITORING_ADMIN
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_WRITE
GROUP_DATA_ACCESS_READ_ONLY
GROUP_READ_ONLY
ldapGroupMappings
.ldapGroups
string array
LDAP project(s) that map to the Ops Manager role.
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.
tags
string array

Tags assigned to the project for use in programmatically identifying the project.

A project can have up to 10 tags. Tags follow these rules:

  • Are case-sensitive

  • Can contain these characters:

    • A through Z

    • 0 through 9

    • . (period)

    • _ (underscore)

    • - (dash)

  • Are limited to 32 characters

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?tag=ABC&tag=DEF&pretty=true"
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}
1{
2 "links": [],
3 "results": [{
4 "id": "xxx",
5 "name": "My Project",
6 "orgId": "111111111cccccf38dc78bdf",
7 "hostCounts": {
8 "arbiter": 2,
9 "config": 1,
10 "primary": 4,
11 "secondary": 8,
12 "mongos": 2
13 },
14 "lastActiveAgent": "2016-08-05T07:23:34Z",
15 "activeAgentCount": 1,
16 "replicaSetCount": 3,
17 "shardCount": 2,
18 "publicApiEnabled": true,
19 "agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e",
20 "tags": ["ABC", "DEF"],
21 "ldapGroupMappings": [{
22 "roleName": "GROUP_OWNER",
23 "ldapGroups": [ project-owner"]
24 }],
25 "links": []
26 }
27 ],
28 "totalCount": 1
29}

Back

Remove One Team From One Project

Next

Users