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.

listBackups

Description

This function returns a list of backups.

Parameters

Parameter name Value Description Possible values Example
type Integer Required
The backup type.
To view the possible values click on Backup Types  
directories[] List List of directories you want to filter with.    
destination String List of destinations id you want to filter with.    
only_snapshots Boolean if only_snapshots set to 1 return only full backups created from snapshots.    

To view available sorting parameters click on List Parameters

Returns

Parameter name Value Description Possible values Example
backups[] List List of backup objects. To view the possible values click on Backup Object  
total Integer The total amount of backups.    

Example