Docs Menu
Docs Home
/ /

atlas api onlineArchive

Returns, adds, edits, or removes an online archive.

The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Name
Type
Required
Description

-h, --help

false

help for onlineArchive

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.

  • atlas api onlineArchive createOnlineArchive - Creates one online archive.

  • atlas api onlineArchive deleteOnlineArchive - Removes one online archive.

  • atlas api onlineArchive downloadQueryLogs - Downloads query logs for the specified online archive.

  • atlas api onlineArchive getOnlineArchive - Returns one online archive for one cluster.

  • atlas api onlineArchive listOnlineArchives - Returns details of all online archives.

  • atlas api onlineArchive updateOnlineArchive - Updates, pauses, or resumes one online archive.

Back

verifyPrivateIpMode

On this page