WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

Backup Object

Parameter name Value Description Possible values Example
_id String The ID of the backup.   5b60420ed5ac5e434a536237
snap_id String The snapshot id.    
name String The name of the backup file.    
type Integer The backup type. To view the possible values click on Backup Types  
params Object
Additional data for the backup.
Exist only on Databases.
   {"engine": "mysql"}
path String The path to the backup file.    
size String The size calculate with calculateBackupSize    
notes String Notes for the backup.    
flag Integer The backup structure.
  • Incremental - 1
  • Archived - 2
  • Compressed - 4
  
flag_name String The backup structure name.
  • Incremental - 1
  • Archived - 2
  • Compressed - 4
  
created String The time that the backup was created.    
engine String The description of the backup engine.
  • JetBackup - 1
  • cPanel - 2
  
engine_val Integer The backup engine.
  • JetBackup - 1
  • cPanel - 2
  
locked Boolean Whether the backup is locked.    
lock_ttl Date/ Empty If the snapshot is locked and the lock_ttl param is not empty, then this is the date when this snapshot will be unlocked automatically.    
hidden Boolean Whether the backup is hidden.    
encrypted Boolean Whether the backup is encrypted.    
require_encryption_key Boolean Whether the backup require encryption key.    
snapshot Boolean Whether it's a backup created from snapshot.    
safety Boolean Whether it's a safety backup.    
destination String The destination name.    
location String The location of the backup. Local/Remote/Safety  
queue Object Whether the backup is in the queue.   {"restore":false, "download":false}
download Boolean Whether the backup has been download.