Returns, adds, and edits collections of clusters and users in MongoDB Cloud.
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Options
Name | Type | Required | Description |
---|---|---|---|
-h, --help | false | help for projects |
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. |
Related Commands
atlas api projects addGroupUser - Adds one MongoDB Cloud user to the specified project.
atlas api projects createGroup - Creates one project.
atlas api projects createGroupInvite - Invites one MongoDB Cloud user to join the specified project.
atlas api projects deleteGroup - Removes the specified project.
atlas api projects deleteGroupInvite - Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project.
atlas api projects deleteGroupLimit - Removes the specified project limit.
atlas api projects getGroup - Returns details about the specified project.
atlas api projects getGroupByName - Returns details about the project identified by its name.
atlas api projects getGroupInvite - Returns the details of one pending invitation to the specified project.
atlas api projects getGroupIpAddresses - Returns all IP addresses for this project.
atlas api projects getGroupLimit - Returns the specified limit for the specified project.
atlas api projects getGroupSettings - Returns details about the specified project's settings.
atlas api projects getMongoDbVersions - Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.
atlas api projects listGroupInvites - Returns all pending invitations to the specified project.
atlas api projects listGroupLimits - Returns all the limits for the specified project.
atlas api projects listGroups - Returns details about all projects.
atlas api projects migrateGroup - Migrates a project from its current organization to another organization.
atlas api projects setGroupLimit - Sets the specified project limit.
atlas api projects updateGroup - Updates the human-readable label that identifies the specified project, or the tags associated with the project.
atlas api projects updateGroupInvites - Updates the details of one pending invitation, identified by the username of the invited user, to the specified project.
atlas api projects updateGroupSettings - Updates the settings of the specified project.
atlas api projects updateGroupUserRoles - Updates the roles of the specified user in the specified project.
atlas api projects updateInviteById - Updates the details of one pending invitation, identified by its unique ID, to the specified project.