Namespace: "urn:zimbraAdmin"
GetQuotaUsage SOAP Command

Get Quota Usage
The target server should be specified in the soap header (see soap.txt, <targetServer>).
When sorting by "quotaLimit", 0 is treated as the highest value possible.

Authorization token required true
Admin Authorization token required true

GetQuotaUsageRequest

    <GetQuotaUsageRequest [domain="{limit-to-domain}"] [allServers="{all-servers} (0|1)"] [limit="(Integer)"]
                             [offset="(Integer)"] [sortBy="{sort-by}"] [sortAscending="{sort-ascending} (0|1)"]
                             [refresh="(0|1)"] /> ## GetQuotaUsageRequest

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

XPath Required / Optional Description
@domain Optional (0 or 1) Type:String
Domain - the domain name to limit the search to
@allServers Optional (0 or 1) Type:0|1
whether to fetch quota usage for all domain accounts from across all mailbox servers, default is false, applicable when domain attribute is specified
@limit Optional (0 or 1) Type:Integer
Limit - the number of accounts to return (0 is default and means all)
@offset Optional (0 or 1) Type:Integer
Offset - the starting offset (0, 25, etc)
@sortBy Optional (0 or 1) Type:String
SortBy - valid values: "percentUsed", "totalUsed", "quotaLimit"
@sortAscending Optional (0 or 1) Type:0|1
Whether to sort in ascending order 0 (false) is default, so highest quotas are returned first
@refresh Optional (0 or 1) Type:0|1
Refresh - whether to always recalculate the data even when cached values are available. 0 (false) is the default.

GetQuotaUsageResponse

    <GetQuotaUsageResponse more="{more-flag} (0|1)" searchTotal="{search-total} (int)"> ## GetQuotaUsageResponse
        (<account name="{account-name}" id="{account-id}" used="{quota-used-bytes} (long)"
                      limit="{quota-limit-bytes} (long)" /> ## AccountQuotaInfo)*
    </GetQuotaUsageResponse>

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

XPath Required / Optional Description
@more Required (only 1) Type:0|1
1 (true) if there are more accounts left to return
@searchTotal Required (only 1) Type:int
Total number of accounts that matched search (not affected by limit/offset)
/account Optional (0 or more) Account quota information
/account@name Required (only 1) Type:String
Account name
/account@id Required (only 1) Type:String
Account ID
/account@used Required (only 1) Type:long
Used quota in bytes, or 0 if no quota used
/account@limit Required (only 1) Type:long
Quota limit in bytes, or 0 if unlimited