mongocli atlas privateendpoint delete
This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.
The privateendpoint delete command deletes one
private endpoint connection for a given Atlas project.
Syntax
mongocli atlas privateendpoint(s)|privateEndpoint(s) delete <private-endpoint-id> [ --force ] [ --profile|-P <profile-name> ] [ --projectId <project-ID> ]
Note
Use -h or --help to view the command-line help for
this command.
Arguments
Argument | Type | Description | Required? |
|---|---|---|---|
<private-endpoint-id> | string | Unique identifier of the private endpoint connection that you
want to delete. | yes |
Options
Option | Type | Description | Required? |
|---|---|---|---|
--force | Flag that indicates that the agent API key can
be deleted without requiring confirmation. | no | |
--profile, -P | string | Name of the profile where the public and private
keys for the project are saved. If omitted, uses the
default profile. To learn more about creating a
profile, see Configure the MongoDB CLI. | no |
--projectId | string | Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable. | no |
Output
If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.
? Are you sure you want to delete: <private-endpoint-id> Yes Private endpoint '<private-endpoint-id>' deleted
Example
The following command deletes one private endpoint connection for a project using the default profile, which contains credentials and the project ID. The output is returned in the default format.
mongocli atlas privateendpoints delete 5f4fc14da2b47835a58c63a2
The previous command prints the following to the terminal.
? Are you sure you want to delete: 5f4fc14da2b47835a58c63a2 Yes Private endpoint '5f4fc14da2b47835a58c63a2' deleted