Create a Project¶

On this page

Syntax
Example
- Request
- Response

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

Syntax¶

copy

POST /api/atlas/v1.0/groups

Request Body Parameters¶

Name	Type	Description
`name`	string	Name of the project to create.
`orgId`	string	Unique identifier of the organization within which to create the project. This field is required when using API Key credentials. Important To create a project using API Key credentials, you must specify an `orgId`. When you do, Atlas automatically selects the `Owner` of the specified organization with the earliest account creation date and time as the `Project Owner` for the newly created project.

Request Query Parameters¶

Field Required/Optional Description

envelope

Optional.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.

pretty

Optional.

A boolean that specifies whether or not to return a “pretty-printed” JSON document.

Defaults to false.

HTTP Response Elements¶

Name	Description
`clusterCount`	The number of Atlas clusters deployed in the project.
`created`	The ISO-8601-formatted timestamp of when Atlas created the project.
`id`	The unique identifier of the project. You can use this value for populating the `{GROUP-ID}` parameter of other Atlas API endpoints.
`links`	One or more links to sub-resources and/or related resources. The relation-types between URLs are explained in the Web Linking Specification.
`name`	The name of the project. You can use this value for populating the `{GROUP-NAME}` parameter of the /groups/byName/{GROUP-NAME} endpoint.
`orgId`	The unique identifier of the Atlas organization to which the project belongs.

Example¶

Request¶

copy

curl -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest -H "Content-Type: application/json" -X POST "https://cloud.mongodb.com/api/atlas/v1.0/groups" --data '{ "name" : "ProjectFoobar", "orgId" : "5a0a1e7e0f2912c554080adc" }'

Response¶

copy

HTTP/1.1 200 OK

{
  "clusterCount" : 0,
  "created" : "2016-07-14T14:19:33Z",
  "id" : "5a0a1e7e0f2912c554080ae6",
  "links" : [],
  "name" : "ProjectFoobar",
  "orgId" : "5a0a1e7e0f2912c554080adc"
}

← Get One Project by Name Delete a Project →