atlas api onlineArchive deleteOnlineArchive
On this page
experimental: Removes one online archive.
This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api onlineArchive deleteOnlineArchive [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--archiveId | string | true | unique 24-hexadecimal digit string that identifies the online archive to delete |
--clusterName | string | true | human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive |
--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 deleteOnlineArchive | |
--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". |
-w, --watch | false | Flag that indicates whether to watch the command until it completes its execution or the watch times out. | |
--watchTimeout | int | false | Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command. |
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. |