atlas api cloudBackups listBackupSnapshots

--clusterName

string

true

Human-readable label that identifies the cluster.

--envelope

envelope

false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

--groupId

string

true

Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

-h, --help

false

help for listBackupSnapshots

--includeCount

totalCount

false

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

--itemsPerPage

int

false

Number of items that the response returns per page.

--oplogInc

oplogTs

false

Oplog operation number that represents the desired point in time. This is the second part of an Oplog timestamp. Must be used with oplogTs. Mutually exclusive with pointInTimeUtcSeconds.

--oplogTs

oplogInc

false

Oplog timestamp that represents the desired point in time. This is the first part of an Oplog timestamp. Must be used with oplogInc. Mutually exclusive with pointInTimeUtcSeconds.

-o, --output

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

--outputFile

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

--pageNum

int

false

Number of the page that displays the current set of the total objects that the response returns.

--pointInTimeUtcSeconds

oplogTs

false

Desired point in time, expressed as the number of seconds that have elapsed since the UNIX epoch. If specified, returns the closest snapshot created before that point in time. Mutually exclusive with oplogTs and oplogInc.

--pretty

false

Flag that indicates whether the response body should be in the prettyprint format.

--version

string

false

API version to use when calling the Atlas API endpoints [options: "2023-01-01"]. If not set by the user, defaults to the latest version or the profile's api_version config value if set. This value defaults to "2023-01-01".