Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas clusters connectionStrings describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Return the SRV connection string for the cluster you specify.

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 connectionStrings describe <clusterName> [options]
Name
Type
Required
Description
clusterName
string
true
Name of the Atlas cluster for which you want to retrieve connection strings.
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.
--type
string
false
When set to 'private', retrieves the connection string for the network peering endpoint. This value defaults to "standard".
Name
Type
Required
Description
-P, --profile
string
false
# Return the JSON-formatted connection strings for the cluster named myCluster:
mongocli atlas clusters connectionStrings describe myCluster --output json
←  mongocli atlas clusters connectionStringsmongocli atlas clusters create →
Share Feedback