Self Help Documentation
< All Topics

file/listfullbackups

Posted
Updated

Description

Lists available full backups and restore points for the given account. This endpoint supports local, remote, custom, and dailycloud backup sources with optional schedule type (hourly, daily, weekly, monthly). If mode and type are omitted, the request defaults to custom, which returns the list of custom backups (e.g. those created via file/generatefullbackup or the panel’s “Generate backup” flow).

Parameters

Additional parameters:

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token — check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
modestringNoBackup source: local, remote, custom, or dailycloud. Default: custom. When custom, lists backups created via “Generate backup” / generatefullbackup.
typestringNoSchedule type when mode is not custom: hourly, daily, weekly, or monthly. Ignored when mode=custom.

Example

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token', // Check API Basics for more information
  'accountuser' => 'spanelio',
  'action' => 'file/listfullbackups',
//'mode' => 'local',   // optional; default is custom
//'type' => 'hourly',   // optional; ignored when mode is custom
];
 
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );

Output

Returns a JSON object with data as an array of restore-point entries. For mode=custom, entries also include description and size.

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
    "result": "success",
    "data": [
        {
            "backup": "09.03.2026.1313-NA:TkE=:4",
            "backupPrettyDisplay": "09.03.2026 at 12:00",
            "backupFilename": "09.03.2026.1313-NA",
            "locked": false,
            "type": "Custom",
            "expiration": "Never",
            "backupTime": 1741600800,
            "description": "My SPanel backup",
            "size": 102400
        }
    ]
}
Table of Contents