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

Create 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.

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

Required Roles

To create a project within an existing organization, you must have one of the following roles in the specified organization:

• Organization Project Creator
• Organization Owner

Resource

copy

POST /groups

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

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

projectOwnerId	string	Required	Unique 24-hexadecimal digit string that identifies the MongoDB Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

Request Body Parameters

Name	Type	Necessity	Description
name	string	Required	Human-readable label that identifies the project.
orgId	string	Required	Unique 24-hexadecimal digit string that identifies the organization within which to create the project. Cloud Manager set the oldest Organization Owner of the specified organization as a Project Owner for the new 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 POST "https://cloud.mongodb.com/api/public/v1.0/groups?projectOwnerId=a138a4bdb497e73460e70d04&pretty=true" \
 --data '
   {
     "name": "Create Project API Example",
     "orgId": "deffb2031b938da53f16d714"
   }'

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 201 Created
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" : 0,
  "agentApiKey" : "{GROUP-API-KEY}",
  "hostCounts" : {
    "arbiter" : 0,
    "config" : 0,
    "master" : 0,
    "mongos" : 0,
    "primary" : 0,
    "secondary" : 0,
    "slave" : 0
  },
  "id" : "{PROJECT-ID}",
  "links" : [],
  "name" : "Create Project API Example",
  "orgId" : "{ORG-ID}",
  "publicApiEnabled" : true,
  "replicaSetCount" : 0,
  "shardCount" : 0,
  "tags" : [ ]
}

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

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