Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists the account's backup files.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Backup/list_backups

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the account's backup files.
$Backup_list_backups = $cpanel->uapi(
    'Backup', 'list_backups'
);

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 account's backup files.
my $Backup_list_backups = $cpliveapi->uapi(
    'Backup', 'list_backups',
);

Note:

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

 cPanel Template Toolkit
<!-- List the account's backup files. -->
[% data = execute( 'Backup', 'list_backups' ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Backup list_backups

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
 
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    "transformed": 1,
    "cnt": 1
  },
  "data": [
    "2014-12-02"
  ]
}


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
dataarrayAn array of the account's backup files.A comma-separated list of dates in YYYY-MM-DD format, where:
  • YYYY represents the year.
  • MM represents the month.
  • DD represents the date.
2014-12-02