Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

atlas serverless backups restores list

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Return all cloud backup restore jobs for the specified serverless instance in your project.

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

Command Syntax
atlas serverless backups restores list <clusterName> [options]
Name
Type
Required
Description

clusterName

string

true

Label that identifies the Atlas serverless instance for which you want to return restore jobs.

Name
Type
Required
Description

-h, --help

false

help for list

--limit

int

false

Number of items per results page, up to a maximum of 500. If you have more than 500 results, specify the --page option to change the results page. This value defaults to 100.

--omitCount

false

Flag that indicates whether the JSON response returns the total number of items (totalCount) in the JSON response.

-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.

--page

int

false

Page number that specifies a page of results. This value defaults to 1.

--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.

# Return all continuous backup restore jobs for the serverless instance Instance0:
atlas serverless backup restore list Instance0

Back

describe