atlas api projects createProject

On this page

Syntax

Options
Inherited Options
Examples

Public Preview: please provide feedback at: 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. To use this resource, the requesting Service Account or API Key must have the Read Write role.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax

atlas api projects createProject [options]

Options

Name	Type	Required	Description
--envelope	envelope	false	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.
--file	string	false	path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
-h, --help		false	help for createProject
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--pretty		false	Flag that indicates whether the response body should be in the prettyprint format.
--projectOwnerId	string	false	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.
--version	string	false	api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

Inherited Options

Name	Type	Required	Description
-P, --profile	string	false	Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Examples

Create the file below and save it as payload.json

# Creates a new project named "MongoTube" with an environment tag set to "e2e"
{
  "name": "MongoTube",
  "orgId": "67b715468c10250b968dcb84",
  "tags": [
    {
      "key": "environment",
      "value": "e2e"
    }
  ]
}

After creating payload.json, run the command below in the same directory.

# Creates a new project named "MongoTube" with an environment tag set to "e2e"
atlas api projects createProject --version 2023-01-01 --file payload.json

Back

addUserToProject

createProjectInvitation