atlas clusters connectionStrings describe

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 SRV connection string for the cluster you specify.

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.
--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	Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

# Return the JSON-formatted connection strings for the cluster named myCluster:
atlas clusters connectionStrings describe myCluster --output json

Back

connectionStrings

create