atlas api privateEndpointServices deletePrivateEndpoint
On this page
experimental: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider.
When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. This command is invoking the endpoint with OperationID: 'deletePrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint
Syntax
atlas api privateEndpointServices deletePrivateEndpoint [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--cloudProvider | string | true | cloud service provider that manages this private endpoint |
--endpointId | string | true | unique string that identifies the private endpoint you want to delete |
--endpointServiceId | string | true | unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint |
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for deletePrivateEndpoint | |
--output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--output-file | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--pretty | false | flag that indicates whether the response body should be in the prettyprint format | |
--version | string | false | api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01". |
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. |