Get One Project by Name¶

On this page

Resource
Request Parameters
Response
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

Resource¶

copy

GET /groups/byName/{GROUP-NAME}

Request Parameters¶

Request Path Parameters¶

Name	Type	Description
GROUP-NAME	string	(Required.) The name of the project.

Request Query Parameters¶

The following query parameters are optional:

Name Type Necessity Description Default

pretty boolean Optional Flag indicating 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 one result, the response body includes:

Name	Description
status	HTTP response code
envelope	Expected response body

false

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

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`
`Project Automation Admin`	`GROUP_AUTOMATION_ADMIN`
`Project Backup Admin`	`GROUP_BACKUP_ADMIN`
`Project Monitoring Admin`	`GROUP_MONITORING_ADMIN`
`Project Data Access Admin`	`GROUP_DATA_ACCESS_ADMIN`
`Project Data Access Read/Write`	`GROUP_DATA_ACCESS_READ_WRITE`
`Project Data Access Read Only`	`GROUP_DATA_ACCESS_READ_ONLY`
`Project 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.

Example Request¶

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/byName/{GROUP-NAME}?pretty=true"

Important

Some characters are not allowed in URLs. These are called reserved characters. If your {GROUP-NAME} includes reserved characters, like spaces, you must replace them with their percent encoding.

Example

Instead of making this request (via curl):

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Project?pretty=true"

Make this request (via curl):

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Group?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

{
  "activeAgentCount": 1,
  "agentApiKey": "{AGENT-API-KEY}",
  "hostCounts": {
    "arbiter": 2,
    "config": 1,
    "primary": 4,
    "secondary": 8,
    "mongos": 2
  },
  "id": "{PROJECT-ID}",
  "ldapGroupMappings" : [ {
    "roleName": "GROUP_OWNER",
    "ldapGroups": [  project-owner" ]
    }, ... ],
  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
  "links" : [],
  "name": "My Project",
  "orgId" : "111111111cccccf38dc78bdf",
  "publicApiEnabled": true,
  "replicaSetCount": 3,
  "shardCount": 2,
  "tags": [ "DEV", "PRODUCT" ]
}

← Get One Project by ID Get One Project by Agent API Key →