atlas api onlineArchive

Atlas CLI support for running commands with the Atlas Administration API is in Preview. The feature and the corresponding documentation might change at any time during the Preview period. To learn more, see Preview Features.

Public Preview: please provide feedback: Returns, adds, edits, or removes an online archive.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Options

Name	Type	Required	Description
-h, --help		false	help for onlineArchive

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.

Related Commands

atlas api onlineArchive createOnlineArchive - Public Preview: please provide feedback: Creates one online archive.
atlas api onlineArchive deleteOnlineArchive - Public Preview: please provide feedback: Removes one online archive.
atlas api onlineArchive downloadOnlineArchiveQueryLogs - Public Preview: please provide feedback: Downloads query logs for the specified online archive.
atlas api onlineArchive getOnlineArchive - Public Preview: please provide feedback: Returns one online archive for one cluster.
atlas api onlineArchive listOnlineArchives - Public Preview: please provide feedback: Returns details of all online archives.
atlas api onlineArchive updateOnlineArchive - Public Preview: please provide feedback: Updates, pauses, or resumes one online archive.

Back

verifyConnectViaPeeringOnlyModeForOneProject

createOnlineArchive