• API >
• Public API Resources >
• Projects and Users >
• Projects >
• Update One Project

Update One Project

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.

Change one project’s name.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource

copy

PATCH /groups/{PROJECT-ID}

Request Parameters

Request Path Parameters

Name	Type	Description
PROJECT-ID	string	(Required.) The unique identifier for 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

Name	Type	Necessity	Description
name	string	Required	The new name for the project.

Response

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}?pretty=true" \
 --data '
 {
   "name" :  "Project Name 1"
 }'

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

{
  "id": "{PROJECT-ID}",
  "name":  "Project Name 1",
  "orgId" : "{ORG-ID}",
  "hostCounts": {
    "arbiter": 2,
    "config": 1,
    "primary": 4,
    "secondary": 8,
    "mongos": 2,
    "master": 0,
    "slave": 0
  },
  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
  "activeAgentCount": 1,
  "replicaSetCount": 3,
  "shardCount": 2,
  "publicApiEnabled": true,
  "agentApiKey": "{API-KEY}",
  "links" : []
}

←   Create One Project Delete One Project  →

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