Disk usage settings restrict the amount of disk space set for various entities (logs, folders, databases, etc.) within a site.

To get these settings, send the get packet and receive the response. The returned disk_usage node has no data type, it is nested within the data node (described in site.xsd) and has the following structure.

image-site-get-disk-usage.gif

  • httpdocs, required

    Specifies the amount of disk space (in bytes) occupied by the /httpdocs directory. Data type: long.

  • httpsdocs, required

    Specifies the amount of disk space (in bytes) occupied by the /httpsdocs directory. Data type: long.

  • subdomains, required

    Specifies the amount of disk space (in bytes) occupied by subdomains on this site. Data type: long.

  • web_users, required

    Specifies the amount of disk space (in bytes) allotted for web users on the site. Data type: long.

  • anonftp, required

    Specifies the amount of disk space (in bytes) occupied by anonymous FTP. Data type: long.

  • logs, required

    Specifies the amount of disk space (in bytes) occupied by logs. Data type: long.

  • dbases, required

    Specifies the amount of disk space (in bytes) occupied by databases created. Data type: long. Makes sense for Plesk for UNIX only.

  • mysql_dbases, required

    Specifies the amount of disk space (in bytes) occupied by MySQL databases created. Data type: integer. Makes sense for Plesk for Windows only.

  • mssql_dbases, required

    Specifies the amount of disk space (in bytes) occupied by MSSQL databases created. Data type: integer. Makes sense for Plesk for Windows only.

  • mailboxes, required

    Specifies the amount of disk space (in bytes) allotted by mailboxes. Data type: long.

  • webapps, required

    Specifies the amount of disk space (in bytes) occupied by Tomcat web applications deployed. Data type: long.

  • maillists, required

    Specifies the amount of disk space (in bytes) occupied by mailing lists. Data type: long.

  • domaindumps, required

    Specifies the amount of disk space (in bytes) occupied by dumps. Data type: long.

  • configs, required

    Specifies the amount of disk space (in bytes) occupied by configuration files. Data type: long. Makes sense for Plesk for UNIX only.

  • chroot, required

    Specifies the amount of disk space (in bytes) occupied by the /chroot directory. Data type: long. Makes sense for Plesk for UNIX only.

The following snippet demonstrates how the disk space usage is presented in the response packets of the get operation:

<disk_usage>
   <httpdocs>2097152</httpdocs>
   <httpsdocs>1572864</httpsdocs>
   <subdomains>12582945</subdomains>
   <web_users>130023456</web_users>
   <anonftp>12582975</anonftp>
   <logs>4194312</logs>
   <dbases>4194325</dbases>
   <mailboxes>12582978</mailboxes>
   <webapps>3145728</webapps>
   <maillists>1048523</maillists>
   <domaindumps>209715200</domaindumps>
   <configs>25078</configs>
   <chroot>2095647</chroot>

Most of these settings cannot be set up directly. You can set only two of them: mailboxes and maillists. The disk_usage node of the set request packet does not have its own data type and is structured as follows:

image-site-set-disk-usage.gif

  • mailboxes, optional

    Specifies the amount of disk space (in bytes) allotted by mailboxes per site. Data type: long.

  • maillists, optional

    Specifies the amount of disk space (in bytes) occupied by mailing lists created per site. Data type: long.

The following snippet sets the limits on the hard disk space for email boxes and mailing lists:

<disk_usage>
    <mailboxes>1073741824</mailboxes>
    <maillists>1048576</maillists>
</disk_usage>
</disk_usage>