atlas api cloudBackups
Public Preview: please provide feedback: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules.
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.
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 - Public Preview: please provide feedback: Cancels one cloud backup restore job of one cluster from the specified project.
atlas api cloudBackups createBackupExportJob - Public Preview: please provide feedback: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket.
atlas api cloudBackups createBackupRestoreJob - Public Preview: please provide feedback: Restores one snapshot of one cluster from the specified project.
atlas api cloudBackups createExportBucket - Public Preview: please provide feedback: Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket.
atlas api cloudBackups createServerlessBackupRestoreJob - Public Preview: please provide feedback: Restores one snapshot of one serverless instance from the specified project.
atlas api cloudBackups deleteAllBackupSchedules - Public Preview: please provide feedback: Removes all cloud backup schedules for the specified cluster.
atlas api cloudBackups deleteExportBucket - Public Preview: please provide feedback: Deletes an Export Bucket.
atlas api cloudBackups deleteReplicaSetBackup - Public Preview: please provide feedback: Removes the specified snapshot.
atlas api cloudBackups deleteShardedClusterBackup - Public Preview: please provide feedback: Removes one snapshot of one sharded cluster from the specified project.
atlas api cloudBackups disableDataProtectionSettings - Public Preview: please provide feedback: Disables the Backup Compliance Policy settings with the specified project.
atlas api cloudBackups getBackupExportJob - Public Preview: please provide feedback: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster.
atlas api cloudBackups getBackupRestoreJob - Public Preview: please provide feedback: Returns one cloud backup restore job for one cluster from the specified project.
atlas api cloudBackups getBackupSchedule - Public Preview: please provide feedback: Returns the cloud backup schedule for the specified cluster within the specified project.
atlas api cloudBackups getDataProtectionSettings - Public Preview: please provide feedback: Returns the Backup Compliance Policy settings with the specified project.
atlas api cloudBackups getExportBucket - Public Preview: please provide feedback: Returns one Export Bucket associated with the specified Project.
atlas api cloudBackups getReplicaSetBackup - Public Preview: please provide feedback: Returns one snapshot from the specified cluster.
atlas api cloudBackups getServerlessBackup - Public Preview: please provide feedback: Returns one snapshot of one serverless instance from the specified project.
atlas api cloudBackups getServerlessBackupRestoreJob - Public Preview: please provide feedback: Returns one restore job for one serverless instance from the specified project.
atlas api cloudBackups getShardedClusterBackup - Public Preview: please provide feedback: Returns one snapshot of one sharded cluster from the specified project.
atlas api cloudBackups listBackupExportJobs - Public Preview: please provide feedback: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster.
atlas api cloudBackups listBackupRestoreJobs - Public Preview: please provide feedback: Returns all cloud backup restore jobs for one cluster from the specified project.
atlas api cloudBackups listExportBuckets - Public Preview: please provide feedback: Returns all Export Buckets associated with the specified Project.
atlas api cloudBackups listReplicaSetBackups - Public Preview: please provide feedback: Returns all snapshots of one cluster from the specified project.
atlas api cloudBackups listServerlessBackupRestoreJobs - Public Preview: please provide feedback: Returns all restore jobs for one serverless instance from the specified project.
atlas api cloudBackups listServerlessBackups - Public Preview: please provide feedback: Returns all snapshots of one serverless instance from the specified project.
atlas api cloudBackups listShardedClusterBackups - Public Preview: please provide feedback: Returns all snapshots of one sharded cluster from the specified project.
atlas api cloudBackups takeSnapshot - Public Preview: please provide feedback: Takes one on-demand snapshot for the specified cluster.
atlas api cloudBackups updateBackupSchedule - Public Preview: please provide feedback: Updates the cloud backup schedule for one cluster within the specified project.
atlas api cloudBackups updateDataProtectionSettings - Public Preview: please provide feedback: Updates the Backup Compliance Policy settings for the specified project.
atlas api cloudBackups updateSnapshotRetention - Public Preview: please provide feedback: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.