Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Solutions
  • 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
    • Stopping and starting clusters
    • Changing cluster and database settings
    • MongoDB version upgrade
    • Database management
    • Managing hosts in a cluster
    • Managing database users
    • Managing backups
    • Managing shards
    • Deleting clusters
  • Solutions
    • Sharding collections
  • Concepts
    • Relationship between service resources
    • Host classes
      • Active host classes
      • Archive
        • Before June 1, 2020
      • Using deprecated 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. get

Method get

  • HTTP request
  • Path parameters
  • Response

Returns the specified MongoDB backup.

To get the list of available MongoDB backups, make a list request.

HTTP request

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

Path parameters

Parameter Description
backupId Required. ID of the backup to return information about. To get the backup ID, use a listBackups request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "sourceClusterId": "string",
  "startedAt": "string",
  "sourceShardNames": [
    "string"
  ],
  "size": "string",
  "type": "string"
}

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

Field Description
id string

ID of the backup.

folderId string

ID of the folder that the backup belongs to.

createdAt string (date-time)

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

String in RFC3339 text format.

sourceClusterId string

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

startedAt string (date-time)

Time when the backup operation was started.

String in RFC3339 text format.

sourceShardNames[] string

Shard names used as a source for backup.

size string (int64)

Size of backup in bytes

type string

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

  • AUTOMATED: Backup created by automated daily schedule
  • MANUAL: Backup created by user request
In this article:
  • HTTP request
  • Path parameters
  • Response
Language / Region
Careers
Privacy policy
Terms of use
Brandbook
© 2021 Yandex.Cloud LLC