Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas dataFederation privateEndpoints create

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Creates a new Data Federation private endpoint.

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

Command Syntax
atlas dataFederation privateEndpoints create <endpointId> [options]
Name
Type
Required
Description
endpointId
string
true
Endpoint identifier of the data federation private endpoint.
Name
Type
Required
Description
--comment
string
false
Optional description or comment for the entry.
-h, --help
false
help for create
-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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Data federation private endpoint {{(index .Results 0).EndpointId> created.
# create data federation private endpoint:
atlas dataFederation privateEndpoints create 507f1f77bcf86cd799439011 --comment "comment"

Back

privateEndpoints