# cPanel API 2 Functions - Backups::listfullbackups

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

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

Warning:
We **strongly** recommend that you use the following
[UAPI](/cpanel/introduction/) function
instead of this function:

- [`Backup::list_backups`](/openapi/cpanel/operation/list_backups/) — This function lists the account's backup files.


## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Backups listfullbackups
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
p
code
status
td
em
string
td
p
The backup's status.
td
ul
li
code
Complete
 — The system completed the file backup.
li
code
Pending
 — The backup process did 
strong
not
 complete.
td
code
Complete
tr
td
code
localtime
td
em
string
td
p
When the backup completed.
td
span
The time and date that the backup completed
, in human-readable 
a
24-hour
 format.
td
pre
code
Fri Nov 1 14:51:47 2013
tr
td
p
code
file
td
em
string
td
p
The backup's name.
td
A 
code
tar.gz
 file name.
td
code
backup-11.1.2013_14-51-47_user.tar.gz
tr
td
p
code
time
td
em
integer
td
p
When the backup completed.
td
The time that the backup completed, in 
a
Unix time
 format.
td
code
1383335507
tr
td
p
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if there was an error.
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
p
code
result
td
em
Boolean
td
p
Whether the function succeeded.
p
br
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1