mongocli atlas privateendpoint interface delete
The privateendpoint interface delete
command removes one interface
endpoint from one private endpoint connection for a given Atlas
project.
Syntax
mongocli atlas privateendpoint(s)|privateEndpoint(s) interface(s) delete <interface-endpoint-id> --privateEndpointId <private-endpoint-id> [ --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? |
---|---|---|---|
<interface-endpoint-id> | string | Unique identifier of the interface endpoint that you
want to remove. | yes |
Options
Option | Type | Description | Required? |
---|---|---|---|
--privateEndpointId | string | Unique identifier of the private endpoint connection that
contains the interface endpoint that you want to remove. | yes |
--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: <interface-endpoint-id> Yes Interface endpoint '<interface-endpoint-id>' deleted
Example
The following command removes one interface endpoint from 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 privateendpoint interface delete vpce-05ad08ff76fceb65b \ --privateEndpointId 5f59240294c39f761dd579c9
The previous command prints the following to the terminal.
? Are you sure you want to delete: vpce-05ad08ff76fceb65b Yes Interface endpoint 'vpce-05ad08ff76fceb65b' deleted