Return cPanel account's mailing list disk usage

This function returns the total disk usage for the mailing lists of a cPanel account.

Important:

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

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Email/get_lists_total_disk_usage

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  get_lists_total_disk_usage

Response samples

application/json

{"apiversion": 3,
"func": "get_lists_total_disk_usage",
"module": "Email",
"result": {"data": 1024,
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}