MOmongodb
Projects

Create One Project

Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings.

post/api/atlas/v2/groups

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

projectOwnerIdstring

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant 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

clusterCountinteger required

Quantity of MongoDB Cloud clusters deployed in this project.

createdstring date-time required

Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

idstring

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.

namestring required

Human-readable label that identifies the project included in the MongoDB Cloud organization.

orgIdstring required

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.

regionUsageRestrictions'COMMERCIAL_FEDRAMP_REGIONS_ONLY' | 'GOV_REGIONS_ONLY'

Applies to Atlas for Government only.

In Commercial Atlas, this field will be rejected in requests and missing in responses.

This field sets restrictions on available regions in the project.

COMMERCIAL_FEDRAMP_REGIONS_ONLY: Only allows deployments in FedRAMP Moderate regions.

GOV_REGIONS_ONLY: Only allows deployments in GovCloud regions.

withDefaultAlertsSettingsboolean

Flag that indicates whether to create the project with default alert settings.

Example request

{
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.