Child pages
  • cPanel API 1 Functions - Fileman::listfullbackups

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function retrieves a list of full server backups.


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended) Backup::list_backups
    Excerpt Include
    DD:UAPI Functions - Backup::list_backupsDD:
    UAPI Functions - Backup::list_backups
    nopaneltrue
  • cPanel API 2 Backups::listfullbackups
    Excerpt Include
    DD:cPanel API 2 Functions - Backups::listfullbackupsDD:
    cPanel API 2 Functions - Backups::listfullbackups
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFileStorageRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$list_backups = $cpanel->api1('Fileman', 'listfullbackups'); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $list_backups = $cpliveapi->api1('Fileman', 'listfullbackups'); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Fileman::listfullbackups ()">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Fileman listfullbackups

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (HTML)


Code Block
languagexml
linenumberstrue
<div
 class="okmsg"><b><a 
href="/download?file=backup-11.30.2009_11-18-35_username.tar.gz">backup-11.30.2009_11-18-35_username.tar.gz</a></b>
 (Mon Nov 30 11:18:35 2009)<br /></div> 
<div class="warningmsg">backup-2.15.2010_10-32-02_username.tar.gz (Mon Feb 15 10:32:02 2010) [in progress]




Parameters

This function does not accept parameters.

Returns

This function returns a full list of backups in HTML-encoded format.