Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Managed Service for MongoDB
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Information about existing clusters
    • Creating clusters
    • Database migration to Yandex.Cloud
    • Connecting to databases
    • Stop and start the cluster
    • Changing cluster and database settings
    • MongoDB version upgrade
    • Database management
    • Managing hosts in a cluster
    • Managing database users
    • Managing backups
    • How to manage shards
    • Deleting clusters
  • Solutions
    • Sharding collections
  • Concepts
    • Relationship between service resources
    • Host classes
    • Network in Yandex Managed Service for MongoDB
    • Quotas and limits
    • Storage types
    • Backups
    • Replication
    • Sharding
    • Users and roles
    • Supported clients
  • Access management
  • Pricing policy
    • Current pricing policy
    • Archive
      • Before January 1, 2019
      • From January 1 to March 1, 2019
      • From March 1, 2019 to February 1, 2020
  • API reference
    • Authentication in the API
    • gRPC
      • Обзор
      • BackupService
      • ClusterService
      • DatabaseService
      • ResourcePresetService
      • UserService
      • OperationService
    • REST
      • Overview
      • Backup
        • Overview
        • get
        • list
      • Cluster
        • Overview
        • addHosts
        • addShard
        • backup
        • create
        • delete
        • deleteHosts
        • deleteShard
        • enableSharding
        • get
        • getShard
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • listShards
        • move
        • rescheduleMaintenance
        • resetupHosts
        • restartHosts
        • restore
        • start
        • stop
        • streamLogs
        • update
      • Database
        • Overview
        • create
        • delete
        • get
        • list
      • ResourcePreset
        • Overview
        • get
        • list
      • User
        • Overview
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
      • Operation
        • Overview
        • get
  • Questions and answers
    • General questions
    • Questions about MongoDB
    • All questions on the same page
  1. API reference
  2. REST
  3. Backup
  4. list

Method list

  • HTTP request
  • Query parameters
  • Response

Retrieves the list of backups available for the specified folder.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-mongodb/v1/backups

Query parameters

Parameter Description
folderId Required. ID of the folder to list backups in. To get the folder ID, use a list request. The maximum string length in characters is 50.
pageSize The maximum value is 1000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "backups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "sourceClusterId": "string",
      "startedAt": "string",
      "sourceShardNames": [
        "string"
      ],
      "size": "string",
      "type": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
backups[] object

A MongoDB Backup resource. For more information, see the Developer's Guide.

backups[].
id
string

ID of the backup.

backups[].
folderId
string

ID of the folder that the backup belongs to.

backups[].
createdAt
string (date-time)

Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).

String in RFC3339 text format.

backups[].
sourceClusterId
string

ID of the MongoDB cluster that the backup was created for.

backups[].
startedAt
string (date-time)

Time when the backup operation was started.

String in RFC3339 text format.

backups[].
sourceShardNames[]
string

Shard names used as a source for backup.

backups[].
size
string (int64)

Size of backup in bytes

backups[].
type
string

How this backup was created (manual/automatic/etc...)

  • AUTOMATED: Backup created by automated daily schedule
  • MANUAL: Backup created by user request
nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.

In this article:
  • HTTP request
  • Query parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC