UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
A server running cPanel.
https://{host}:{port}/execute/
Request
This function returns the disk space that the main account uses.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_main_account_disk_usage
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_main_account_disk_usage
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_main_account_disk_usageResponse
application/json
{ "apiversion": 3, "func": "get_main_account_disk_usage", "module": "Email", "result": { "data": "3076 bytes", "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function returns the disk space that the cPanel account uses.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_main_account_disk_usage_bytes
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_main_account_disk_usage_bytes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_main_account_disk_usage_bytesResponse
application/json
{ "apiversion": 3, "func": "get_main_account_disk_usage_bytes", "module": "Email", "result": { "data": 3076, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves the account's maximum email quota size, in bytes format.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_max_email_quota
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_max_email_quota
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_max_email_quotaResponse
application/json
{ "apiversion": 3, "func": "get_max_email_quota", "module": "Email", "result": { "data": 4503599627370496, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }