- 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.
experimental: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules.
This resource applies only to clusters that use Cloud Backups.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for cloudBackups |
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 cloudBackups cancelBackupRestoreJob - experimental: Cancels one cloud backup restore job of one cluster from the specified project.
atlas api cloudBackups createBackupExportJob - experimental: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket.
atlas api cloudBackups createBackupRestoreJob - experimental: Restores one snapshot of one cluster from the specified project.
atlas api cloudBackups createExportBucket - experimental: Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container.
atlas api cloudBackups deleteAllBackupSchedules - experimental: Removes all cloud backup schedules for the specified cluster.
atlas api cloudBackups deleteExportBucket - experimental: Deletes an Export Bucket.
atlas api cloudBackups deleteReplicaSetBackup - experimental: Removes the specified snapshot.
atlas api cloudBackups deleteShardedClusterBackup - experimental: Removes one snapshot of one sharded cluster from the specified project.
atlas api cloudBackups disableDataProtectionSettings - experimental: Disables the Backup Compliance Policy settings with the specified project.
atlas api cloudBackups getBackupExportJob - experimental: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster.
atlas api cloudBackups getBackupRestoreJob - experimental: Returns one cloud backup restore job for one cluster from the specified project.
atlas api cloudBackups getBackupSchedule - experimental: Returns the cloud backup schedule for the specified cluster within the specified project.
atlas api cloudBackups getDataProtectionSettings - experimental: Returns the Backup Compliance Policy settings with the specified project.
atlas api cloudBackups getExportBucket - experimental: Returns one Export Bucket associated with the specified Project.
atlas api cloudBackups getReplicaSetBackup - experimental: Returns one snapshot from the specified cluster.
atlas api cloudBackups getShardedClusterBackup - experimental: Returns one snapshot of one sharded cluster from the specified project.
atlas api cloudBackups listBackupExportJobs - experimental: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster.
atlas api cloudBackups listBackupRestoreJobs - experimental: Returns all cloud backup restore jobs for one cluster from the specified project.
atlas api cloudBackups listExportBuckets - experimental: Returns all Export Buckets associated with the specified Project.
atlas api cloudBackups listReplicaSetBackups - experimental: Returns all snapshots of one cluster from the specified project.
atlas api cloudBackups listShardedClusterBackups - experimental: Returns all snapshots of one sharded cluster from the specified project.
atlas api cloudBackups takeSnapshot - experimental: Takes one on-demand snapshot for the specified cluster.
atlas api cloudBackups updateBackupSchedule - experimental: Updates the cloud backup schedule for one cluster within the specified project.
atlas api cloudBackups updateDataProtectionSettings - experimental: Updates the Backup Compliance Policy settings for the specified project.
atlas api cloudBackups updateSnapshotRetention - experimental: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.