Child pages
  • cPanel API 2 Functions - Backups::listfullbackups
Skip to end of metadata
Go to start of metadata

Description

This function displays pending and completed backups in the /home directory.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Examples


 WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Backups&cpanel_jsonapi_func=listfullbackups


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the /home directory backups.
$list_backups = $cpanel->api2(
    'Backups', 'listfullbackups'

);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List the /home directory backups.
my $list_backups = $cpliveapi->api2(
    'Backups', 'listfullbackups',

);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 

 Command Line
cpapi2 --user=username Backups listfullbackups


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listfullbackups",
    "data": [
      {
        "localtime": "Fri Nov  1 14:51:47 2013",
        "status": "complete",
        "time": 1383335507,
        "file": "backup-11.1.2013_14-51-47_user.tar.gz"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Backups"
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

status

string

The backup's status.

  • Complete — The system completed the file backup.
  • Pending — The backup process did not complete.
Complete

localtime

string

When the backup completed.

The time and date that the backup completed, in human-readable 24-hour format.
Fri Nov  1 14:51:47 2013

file

string

The backup's name.

A tar.gz file name.
backup-11.1.2013_14-51-47_user.tar.gz

time

integer

When the backup completed.

The time that the backup completed, in Unix time format.
1383335507

reason

string

A reason for failure.

Note:

This function only returns a reason value if there was an error.

A string that describes the error. This is an error message.

result

Boolean

Whether the function succeeded.

 

  • 1 — The function succeeded.
  • 0 — The function failed.
1