Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
Backup SOAP Command

Do a backup
<account> elements are required when method=full and server is running in standard backup mode. If server is running in auto-grouped backup mode, omit the account list in full backup request to trigger auto-grouped backup. If account list is specified, only those accounts will be backed up.

When sync is 1, the full backup is run synchronously; otherwise full backup is started and run in a separate thread and the soap call can return with the backup label.

or

 <BackupRequest>
   <backup method="abort" 
   [target="{path to backup target}"] label="{full backup label to abort}"/>
 </BackupRequest>
 
label is only meaningful and required in the request when method is abort.

or
 <BackupRequest>
    <backup method="delete" 
    [target="{path to backup target}"] before="{full backup label}|{date}"]/>
 </BackupRequest>
 
date is in YYYY/MM/DD[-hh:mm:ss] or nn{d|m|y} where d = day, m = month, y = year

E.g., before="7d" means delete backups older than 7 days
before="1y" means delete backups older than a year.
 <BackupResponse>
    [<backup label="{full backup set label}" incr-label="{incremental backup label}"/>]
 </BackupResponse>
 

label attr is only meaningful upon return from full backup.
During incremental backup, a full backup may be performed if one has never been done for some of the accounts. In that case, both label and incr-label attrs are set in the response.

Network edition only API TRUE
Authorization token required true
Admin Authorization token required true

BackupRequest

    <BackupRequest> ## BackupRequest
        <backup [method="{backup-method}"] [target="{path-to-backup-target}"] [label="{full-backup-label}"]
                   [before="{before}"] [sync="{sync-flag} (0|1)"] [searchIndex="{include-search-index-setting}"]
                   [blobs="{include-blobs-setting}"] [secondaryBlobs="{include-secondary-blobs-setting}"]
                   [zip="{backup-blobs-to-zip} (0|1)"] [zipStore="{zip-store} (0|1)"]> ## BackupSpec
            <fileCopier [fcMethod="{file-copier-method}"] [fcIOType="..."] [fcOIOCopyBufferSize="(Integer)"]
                            [fcAsyncQueueCapacity="(Integer)"] [fcParallelWorkers="(Integer)"] [fcPipes="(Integer)"]
                            [fcPipeBufferSize="(Integer)"] [fcPipeReadersPerPipe="(Integer)"]
                            [fcPipeWritersPerPipe="(Integer)"] /> ## FileCopierSpec
            (<account name="{name}" /> ## Name)*
        </backup>
    </BackupRequest>

The following table describes elements and attributes you can define within a <BackupRequest> element:

XPath Required / Optional Description
/backup Required (only 1) Backup specification
/backup@method Optional (0 or 1) Type:String
Backup method - full|incremental|abort|delete
/backup@target Optional (0 or 1) Type:String
Path to backup target
/backup@label Optional (0 or 1) Type:String
Full backup label
/backup@before Optional (0 or 1) Type:String
Used for selecting backups to delete for method="delete".
Value is either a full backup label or a date or a time period.
If it is a date, the format is YYYY/MM/DD[-hh:mm:ss] If it is a time period, the format is nn{d|m|y} where d = day, m = month, y = year
e.g., before="7d" means delete backups older than 7 days. before="1y" means delete backups older than a year.
/backup@sync Optional (0 or 1) Type:0|1
Run synchronously; command doesn't return until backup is finished
/backup@searchIndex Optional (0 or 1) Type:String
Option to include/exclude search index in a full backup (not applicable in incremental backup). Values: include|exclude|config
Default value is "config", to use the configured value. "include" or "exclude" overrides the configuration.
/backup@blobs Optional (0 or 1) Type:String
Option to include/exclude blobs in a full backup (not applicable in incremental backup). Values: include|exclude|config
Default value is "config", to use the configured value. "include" or "exclude" overrides the configuration.
/backup@secondaryBlobs Optional (0 or 1) Type:String
Option to include/exclude secondary blobs in a full backup (not applicable in incremental backup). Values: include|exclude|config
Default value is "config", to use the configured value. "include" or "exclude" overrides the configuration.
Meaningful only when blob backup isn't excluded
/backup@zip Optional (0 or 1) Type:0|1
Backup blobs to zip files. Defaults to 1 (true)
/backup@zipStore Optional (0 or 1) Type:0|1
if set, store blobs uncompressed in zip files (used only when {backup-blobs-to-zip} is set. Defaults to 1 (true)
/backup/fileCopier Optional (0 or 1) File copier specification
/backup/fileCopier@fcMethod Optional (0 or 1) Type:String
File copier method - PARALLEL | PIPE | SERIAL
/backup/fileCopier@fcIOType Optional (0 or 1) Type:String
fcIOTYpe - OIO | NIO. For all methods
/backup/fileCopier@fcOIOCopyBufferSize Optional (0 or 1) Type:Integer
fcOIOCopyBufferSize in bytes. For all methods
/backup/fileCopier@fcAsyncQueueCapacity Optional (0 or 1) Type:Integer
fcAsyncQueueCapacity. For PARALLEL and PIPE only
/backup/fileCopier@fcParallelWorkers Optional (0 or 1) Type:Integer
fcParallelWorkers. For PARALLEL only
/backup/fileCopier@fcPipes Optional (0 or 1) Type:Integer
fcPipes. For PIPE only
/backup/fileCopier@fcPipeBufferSize Optional (0 or 1) Type:Integer
fcPipeBufferSize. For PIPE only
/backup/fileCopier@fcPipeReadersPerPipe Optional (0 or 1) Type:Integer
fcPipeReadersPerPipe. For PIPE only
/backup/fileCopier@fcPipeWritersPerPipe Optional (0 or 1) Type:Integer
fcPipeWritersPerPipe. Ffor PIPE only
/backup/account Optional (0 or more) Account selector - either one <account name="all"/> or a list of <account name="{account email addr}"/>
/backup/account@name Required (only 1) Type:String
Name

BackupResponse

    <BackupResponse> ## BackupResponse
        <backup [label="{full-backup-set-label}"] [incr-label="{incremental-backup-label}"] /> ## BackupInfo
    </BackupResponse>

The following table describes elements and attributes you can define within a <BackupResponse> element:

XPath Required / Optional Description
/backup Required (only 1) Information about the backup
/backup@label Optional (0 or 1) Type:String
Full backup set label
/backup@incr-label Optional (0 or 1) Type:String
Incremental backup label