Docs Menu

Docs HomeAtlas CLI

atlas backups exports buckets describe

On this page

  • Syntax
  • Options
  • Inherited Options
  • Output
  • Examples

Return one snapshot export bucket.

To use this command, you must authenticate with a user account or an API key with the Project Read Only role.

Command Syntax
atlas backups exports buckets describe [options]
Name
Type
Required
Description
--bucketId
string
true
Unique identifier that Atlas assigns to the bucket.
-h, --help
false
help for describe
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

ID BUCKET NAME CLOUD PROVIDER IAM ROLE ID
<Id> <BucketName> <CloudProvider> <IamRoleId>
# Return the details for the continuous backup export bucket with the ID dbdb00ca12345678f901a234:
atlas backup exports buckets describe dbdb00ca12345678f901a234
←  atlas backups exports buckets deleteatlas backups exports buckets list →