Docs Menu

Docs HomeAtlas Command Line Interface

atlas dataLakes list

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Return all federated database instances for your project.

To learn more about Atlas Data Federation (previously named Atlas Data Lake), see https://www.mongodb.com/docs/atlas/data-federation/overview/.

atlas dataLakes list [options]
Name
Type
Required
Description
-h, --help
false
help for list
-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.
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 a JSON-formatted list of all federated database instances in the project with the ID 5e2211c17a3e5a48f5497de3:
atlas dataLakes list --projectId 5e2211c17a3e5a48f5497de3 --output json
←  atlas dataLakes describeatlas dataLakes update →

Specify your version