Returns a (partial) list of the backup records known to the component. The records are presented in reverse order, i.e. the first record is the last backup attempt, whereas the last record is the earliest backup attempt known to the component.

Request Data expected

All fields are optional. You can have a null data body.


Integer. Default = 0. The starting offset of the list, maps to the limitstart parameter in the Joomla! API.


Integer. Default = 50. How many records to return at once, maps to the limit parameter in the Joomla! API. You can set it to 0 to return all records, but do note that this may cause a server timeout.

Response Data returned

A list of JSON objects. Each object has the following format:


Integer. The numeric ID of the backup record, used whenever you want to fetch files, delete files, etc.


String. The short backup description.


String. The longer backup comment. Expect it to contain HTML.


String. A MySQL timestamp of the time the backup started, e.g. "2010-07-21 16:30:00".


String. A MySQL timestamp of the time the backup finished, e.g. "2010-07-21 16:30:00".


String. The status of this backup run. Can be one of:

  • run The backup is still running, or it's stuck

  • fail The backup has failed

  • complete The backup has run successfully


String. The backup origin. Indicates where the backup was started from. This list continues to expand and now consists of:

  • backend A back-end manual backup

  • frontend A front-end backup, using the redirects API

  • cli A native command line backup using backup.php (probably in a CRON job)

  • lite A front-end manual backup using the Lite Mode

  • json A remote backup using the JSON API

  • xmlrpc A remote backup using the XML-RPC API


String. The backup mode used in that backup. Can be one of:

  • full Full backup (default)

  • dbonly Main site database only backup to SQL files

  • extradbonly Extra Databases only backup

  • alldb All databases (main site and any extra databases) backup

  • fileonly Files only backup, non-incremental

  • incfile Files only backup, incremental


Integer. The numeric Backup Profile ID


String. The base name of the archive and its extension, e.g. foobar.jpa


String. The full absolute file system path to the archive file, e.g. /home/myuser/public_html/backups/foobar.jpa.


Integer. The number of archive parts of this backup. 0 and 1 both mean only 1 part is present.


Reserved for future use.


Integer. Non-zero values mean that the archive files are still present in the server. A zero value means that the files no longer exist on the server.


String. The combination of status and filesexist fields:

  • ok A successful backup whose files exist on the server

  • obsolete A successful backup whose files no longer exist on the server

  • pending A backup still running, or stuck

  • fail A backup which failed


Integer. The total size of all archive parts. Do note that 32-bit versions of PHP overflow past 2Gb. You can't rely on this field.