ANNOUNCEMENT: Voyage AI joins MongoDB to power more accurate and trustworthy AI applications on Atlas.
Learn more
Docs Menu

atlas dataFederation privateEndpoints describe

Return the details for the specified data federation private endpoint for your project.

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 describe <endpointId> [options]
Name
Type
Required
Description

endpointId

string

true

Endpoint identifier of the data federation private endpoint.

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.

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.

# retrieves data federation private endpoint '507f1f77bcf86cd799439011':
atlas dataFederation privateEndpoints describe 507f1f77bcf86cd799439011