atlas config set
Configure specific properties of a profile.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Syntax
atlas config set <propertyName> <value> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
propertyName | string | true | Property to set in the profile. Valid values for Atlas CLI are project_id, org_id, service, public_api_key, private_api_key, output, mongosh_path, skip_update_check, telemetry_enabled, access_token, and refresh_token. |
value | string | true | Value for the property to set in the profile. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for set |
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
Set the organization ID in the default profile to 5dd5aaef7a3e5a6c5bd12de4: atlas config set org_id 5dd5aaef7a3e5a6c5bd12de4