Skip to content

[v4] backup.status

Rich Infante edited this page Apr 19, 2018 · 2 revisions

This report gets status information about a specific backup.

  • Name: backup.status
  • Parameters
    • backup can be a string representing the ID, or a Backup instance.
  • Output: Object formatted like below.
{
  uuid: String, // UUID, presumably to uniquely identify the backup. 
  isFullBackup: String, // Is a full backup? usually false.
  version: String, // Backup version, seen 2.4 and 3.2
  backupState: String, // State of the backup, typically "new"
  date: String, // Date the backup was taken
  snapshotState: String // Snapshot state, "finished" if the backup is done.
}