atlas dataFederation privateEndpoints delete
Remove the specified data federation private endpoint from your project.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
Syntax
atlas dataFederation privateEndpoints delete <endpointId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
endpointId | string | true | Endpoint identifier of the data federation private endpoint. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--force | false | Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. | |
-h, --help | false | help for delete | |
--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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
'<Name>' deleted
Examples
# deletes data federation private endpoint '507f1f77bcf86cd799439011': atlas dataFederation privateEndpoints delete 507f1f77bcf86cd799439011