Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas projects update

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Update a project.

To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Command Syntax
atlas projects update <ID> [options]
Name
Type
Required
Description
ID
string
true
ID of the project you want to update.
Name
Type
Required
Description
-f, --file
string
true
Path to the JSON configuration file that defines project configuration settings. To learn more about project configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/project-config-file.
-h, --help
false
help for update
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Project '<Id>' updated.
# Update a project with the ID 5e2211c17a3e5a48f5497de3 using the JSON file named myProject.json:
atlas projects update 5f4007f327a3bd7b6f4103c5 --file myProject.json --output json
← update
users →