- 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.
Deletes an Atlas Stream Processing PrivateLink endpoint.
To use this command, you must authenticate with a user account or an API key with any of the following roles: Project Owner, Project Stream Processing Owner.
Syntax
atlas streams privateLinks delete <connectionID> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
connectionID | string | true | ID of the PrivateLink 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.
Atlas Stream Processing PrivateLink endpoint '<Name>' deleted.
Examples
# delete an Atlas Stream Processing PrivateLink endpoint: atlas streams privateLink delete 5e2211c17a3e5a48f5497de3