Zimbra SOAP API Reference 23.7.0

Command: Restore
Namespace: urn:zimbraAdmin
Description: Perform an action related to a Restore from backup

When includeIncrementals is 1 (true), any incremental backups from the last full backup are also restored. Default to 1 (true).
when sysData is 1 (true), restore system tables and local config.
if label is not specified, restore from the latest full backup.
prefix is used to produce new account names if the name is reused or a new account is to be created

Properties:

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

    <RestoreRequest> ## RestoreRequest
        <restore [method="..."] [searchIndex="..."] [blobs="..."] [secondaryBlobs="..."] [target="..."] [label="..."]
                    [sysData="(0|1)"] [includeIncrementals="(0|1)"] [replayRedo="(0|1)"] [continue="(0|1)"] [prefix="..."]
                    [restoreToTime="(Long)"] [restoreToRedoSeq="(Long)"] [restoreToIncrLabel="..."]
                    [ignoreRedoErrors="(0|1)"] [skipDeleteOps="(0|1)"] [skipDeletedAccounts="(0|1)"]> ## RestoreSpec
            <fileCopier [fcMethod="..."] [fcIOType="..."] [fcOIOCopyBufferSize="(Integer)"]
                            [fcAsyncQueueCapacity="(Integer)"] [fcParallelWorkers="(Integer)"] [fcPipes="(Integer)"]
                            [fcPipeBufferSize="(Integer)"] [fcPipeReadersPerPipe="(Integer)"]
                            [fcPipeWritersPerPipe="(Integer)"] /> ## FileCopierSpec
            (<account name="..." /> ## Name)*
        </restore>
    </RestoreRequest>

elements and attributes you can define within a <RestoreRequest> element:

XPath

Required / Optional

Description

/restore

Required (only 1)

Optional (0 or 1)

Type: String

/restore@searchIndex

Optional (0 or 1)

Type: String