Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules.
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.
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 - Cancels one cloud backup restore job of one cluster from the specified project.
atlas api cloudBackups createBackupExport - Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket.
atlas api cloudBackups createBackupRestoreJob - Restores one snapshot of one cluster from the specified project.
atlas api cloudBackups createExportBucket - Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket.
atlas api cloudBackups deleteBackupShardedCluster - Removes one snapshot of one sharded cluster from the specified project.
atlas api cloudBackups deleteClusterBackupSchedule - Removes all cloud backup schedules for the specified cluster.
atlas api cloudBackups deleteClusterBackupSnapshot - Removes the specified snapshot.
atlas api cloudBackups deleteExportBucket - Deletes an Export Bucket.
atlas api cloudBackups disableCompliancePolicy - Disables the Backup Compliance Policy settings with the specified project.
atlas api cloudBackups getBackupExport - Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster.
atlas api cloudBackups getBackupRestoreJob - Returns one cloud backup restore job for one cluster from the specified project.
atlas api cloudBackups getBackupSchedule - Returns the cloud backup schedule for the specified cluster within the specified project.
atlas api cloudBackups getBackupShardedCluster - Returns one snapshot of one sharded cluster from the specified project.
atlas api cloudBackups getClusterBackupSnapshot - Returns one snapshot from the specified cluster.
atlas api cloudBackups getCompliancePolicy - Returns the Backup Compliance Policy settings with the specified project.
atlas api cloudBackups getExportBucket - Returns one Export Bucket associated with the specified Project.
atlas api cloudBackups listBackupExports - Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster.
atlas api cloudBackups listBackupRestoreJobs - Returns all cloud backup restore jobs for one cluster from the specified project.
atlas api cloudBackups listBackupShardedClusters - Returns all snapshots of one sharded cluster from the specified project.
atlas api cloudBackups listBackupSnapshots - Returns all snapshots of one cluster from the specified project.
atlas api cloudBackups listExportBuckets - Returns all Export Buckets associated with the specified Project.
atlas api cloudBackups takeSnapshots - Takes one on-demand snapshot for the specified cluster.
atlas api cloudBackups updateBackupSchedule - Updates the cloud backup schedule for one cluster within the specified project.
atlas api cloudBackups updateBackupSnapshot - Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.
atlas api cloudBackups updateCompliancePolicy - Updates the Backup Compliance Policy settings for the specified project.