Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas clusters describe

On this page

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

Return the details for the specified cluster for your project.

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

Command Syntax
mongocli atlas clusters describe <clusterName> [options]
Name
Type
Required
Description
clusterName
string
true
Name of the cluster to retrieve.
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 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.
Name
Type
Required
Description
-P, --profile
string
false

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

ID NAME MDB VER STATE
<Id> <Name> <MongoDBVersion> <StateName>
# Return the JSON-formatted details for the cluster named myCluster:
mongocli atlas clusters describe myCluster --output json
←  mongocli atlas clusters deletemongocli atlas clusters indexes →
Share Feedback
© 2023 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2023 MongoDB, Inc.