Docs Menu

Rename One Project

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Example Header
  • Example Body
Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

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

PATCH /groups/{GROUP-ID}
Path Element
Type
Necessity
Description
GROUP-ID
string
Required
Unique 24-hexadecimal character string that identifies the project.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these 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 indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These 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:

status
HTTP response code
envelope
Expected response body
false
Parameter
Type
Necessity
Description
name
string
Required
Human-readable label that you want to have identify the specified project.
Response Parameter
Type
Description
id
string
Unique 24-hexadecimal character string that identifies the project.
orgId
string
Unique 24-hexadecimal character string that identifies the Atlas organization to which the project belongs.
name
string
Human-readable label that identifies the project.
publicApiEnabled
Boolean
Flag that indicates whether someone enabled the API for the specified organization.
hostCounts
string
Quantity of hosts managed in the specified project.
lastActiveAgent
string
Timestamp in ISO 8601 date and time format in UTC when one of the MongoDB Agents sent a ping indicating activity.
activeAgentCount
integer
Quantity of MongoDB Agents currently running in the specified project.
replicaSetCount
integer
Quantity of replica sets included in the specified project.
shardCount
integer
Quantity of shards included in the specified project.
agentApiKey
string
Human-readable label that identifies the MongoDB Agents API key.
ldapGroupMappings
array
List of LDAP groups mapped to the specified project.
tags
array
List of labels applied to the specified project.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID} \"
--data '{
"name" : "updatedProject"
}'
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}
1{
2 "id" : "{GROUP-ID}",
3 "orgId" : "{ORG-ID}",
4 "name" : "updatedProject",
5 "publicApiEnabled" : true,
6 "hostCounts" : 10,
7 "lastActiveAgent" : "",
8 "activeAgentCount" : 4,
9 "replicaSetCount" : 2,
10 "shardCount" : 8,
11 "agentApiKey" : "{AGENT-API-KEY}",
12 "ldapGroupMappings" : [""],
13 "tags" : [""]
14}
Give Feedback
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.