- 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 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.
Syntax
atlas dataFederation privateEndpoints describe <endpointId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
endpointId | string | true | Endpoint identifier of the data federation private endpoint. |
Options
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. |
Inherited Options
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. |
Examples
# retrieves data federation private endpoint '507f1f77bcf86cd799439011': atlas dataFederation privateEndpoints describe 507f1f77bcf86cd799439011