Docs Home → MongoDB Command Line Interface
mongocli atlas backups snapshots create
On this page
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.Create a backup snapshot for your project and cluster.
Syntax
mongocli atlas backups snapshots create <clusterName> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
clusterName | string | true | Name of the Atlas cluster whose snapshot you want to restore. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--desc | string | true | Description of the on-demand snapshot. |
-h, --help | false | help for create | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. |
--projectId | string | false | Project ID to use. Overrides the settings in the configuration file or environment variable. |
--retention | int | false | Number of days that Atlas should retain the on-demand snapshot. Must be at least 1. This value defaults to 1. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |