Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli iam projects describe

On this page

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

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.

Command Syntax
mongocli iam projects describe <ID> [options]
Name
Type
Required
Description
ID
string
true
Unique 24-digit string that identifies the project.
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.
Name
Type
Required
Description
-P, --profile
string
false
Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

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

ID NAME
<ID> <Name>
# Return the JSON-formatted details for the project with the ID 5e2211c17a3e5a48f5497de3:
mongocli projects describe 5e2211c17a3e5a48f5497de3 --output json
←  mongocli iam projects deletemongocli iam projects invitations →