- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
Return the details for the specified project.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
Command Syntax
atlas projects describe <ID> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
ID | string | true | Unique 24-digit string that identifies the project. |
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. |
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.
ID NAME <Id> <Name>
Examples
# Return the JSON-formatted details for the project with the ID 5e2211c17a3e5a48f5497de3: atlas projects describe 5e2211c17a3e5a48f5497de3 --output json