v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Accounts

Return email account's disk usage

This function retrieves the disk space that an email account uses.

Important:

When you disable the Receive Mail role, the system disables this function.

get/Email/get_disk_usage

Query parameters

domainstring domain required
Example:example.com

The email account's domain.

userstring username required
Example:user

The email account username.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_disk_usage",
  "module": "Email",
  "result": {
    "data": {
      "diskused": 399.6,
      "domain": "example.com",
      "login": "user@example.com",
      "user": "user"
    },
    "status": 1
  }
}