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

Backup Account query
For each account <backup> is listed from the most recent to earlier ones.

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

BackupAccountQueryRequest

    <BackupAccountQueryRequest> ## BackupAccountQueryRequest
        <query [target="{path-to-backup-target}"] [type="{backup-type}"] [from="{start-time-millis} (Long)"]
                  [to="{end-time-millis} (Long)"] [backupListOffset="{backup-list-offset-number} (Integer)"]
                  [backupListCount="{backup-list-count-number} (Integer)"]> ## BackupAccountQuerySpec
            (<account name="{name}" /> ## Name)*
        </query>
    </BackupAccountQueryRequest>

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

XPath Required / Optional Description
/query Required (only 1) Query
/query@target Optional (0 or 1) Type:String
Path to backup target
/query@type Optional (0 or 1) Type:String
Backup type - full|incremental. Means both types if omitted or bogus value
/query@from Optional (0 or 1) Type:Long
Return backups whose start time is at or after this time. Defaults to beginning of time if not specified.
/query@to Optional (0 or 1) Type:Long
Return backups whose start time is at or before this time. Defaults to end of time if not specified
/query@backupListOffset Optional (0 or 1) Type:Integer
Backup list offset number. Default = 0
/query@backupListCount Optional (0 or 1) Type:Integer
Backup list count number. Default = -1, meaning all
/query/account Optional (0 or more) Either the account email address or all
/query/account@name Required (only 1) Type:String
Name

BackupAccountQueryResponse

    <BackupAccountQueryResponse> ## BackupAccountQueryResponse
        (<account name="..." [more="{more-flag} (0|1)"]> ## BackupAccountQueryInfo
            (<backup [label="{backup-label}"] [type="{backup-type}"] [start="{start-time-in-millis} (Long)"]
                         [end="{end-time-in-millis} (Long)"] [accountId="{account-uid}"] /> ## BackupAccountQueryBackupInfo)*
          </account>)*
    </BackupAccountQueryResponse>

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

XPath Required / Optional Description
/account Optional (0 or more) Account backup details
/account@name Required (only 1) Type:String
/account@more Optional (0 or 1) Type:0|1
Present if there are more backups to page through
/account/backup Optional (0 or more) Information about backup
/account/backup@label Optional (0 or 1) Type:String
Backup label
/account/backup@type Optional (0 or 1) Type:String
Backup type - full|incremental
/account/backup@start Optional (0 or 1) Type:Long
Start time in milliseconds
/account/backup@end Optional (0 or 1) Type:Long
End time in milliseconds
/account/backup@accountId Optional (0 or 1) Type:String
Account UID