atlas projects settings describe
Retrieve details for settings to the specified project.
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 projects settings describe [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for describe | |
-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. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
COLLECT DATABASE SPECIFICS STATISTICS ENABLED DATA EXPLORER ENABLED DATA EXPLORER GEN AI FEATURES ENABLED DATA EXPLORER GEN AI SAMPLE DOCUMENT PASSING ENABLED PERFORMANCE ADVISOR ENABLED REALTIME PERFORMANCE PANEL ENABLED SCHEMA ADVISOR ENABLED <IsCollectDatabaseSpecificsStatisticsEnabled> <IsDataExplorerEnabled> <IsDataExplorerGenAIFeaturesEnabled> <IsDataExplorerGenAISampleDocumentPassingEnabled> <IsPerformanceAdvisorEnabled> <IsRealtimePerformancePanelEnabled> <IsSchemaAdvisorEnabled>
Examples
# This example uses the profile named "myprofile" for accessing Atlas. atlas projects settings describe -P myprofile --projectId 5e2211c17a3e5a48f5497de3