Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas dataFederation privateEndpoints list

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Returns all data federation private endpoints for your project.

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

Command Syntax
atlas dataFederation privateEndpoints 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. 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.

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.

# list all data federation private endpoints:
atlas dataFederation privateEndpoints list

Back

describe