Email
Email Accounts

Return primary email account's disk usage in bytes

This function returns the disk space that the cPanel account uses.

Important:

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

get/Email/get_main_account_disk_usage_bytes

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

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_main_account_disk_usage_bytes",
  "module": "Email",
  "result": {
    "data": 3076,
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.