Backup

A set of methods for managing MongoDB Backup resources.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "sourceClusterId": "string",
  "startedAt": "string",
  "sourceShardNames": [
    "string"
  ]
}
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.

Methods

Method Description
get Returns the specified MongoDB backup.
list Retrieves the list of backups available for the specified folder.