Method get

Returns the specified MongoDB backup.

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

HTTP request


Path parameters

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


HTTP Code: 200 - OK

  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "sourceClusterId": "string",
  "startedAt": "string",
  "sourceShardNames": [

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.