Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

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 with the Project Read Only role.

Command Syntax
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 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.
--type
string
false
Type of connection string. If you specify 'private', this option retrieves the connection string for the network peering endpoint. This value defaults to 'standard'. This value defaults to "standard".
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.
# Return the JSON-formatted connection strings for the cluster named myCluster:
atlas clusters connectionStrings describe myCluster --output json
← atlas clusters connectionStrings