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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/export_lists
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/export_lists
- 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/export_listsResponse
application/json
{ "apiversion": 3, "func": "export_lists", "module": "Email", "result": { "data": {}, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function generates a one-time password (OTP) for a mailing list.
Note:
The generated password expires after one use.
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/generate_mailman_otp
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/generate_mailman_otp
- 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/generate_mailman_otp?list=mylist'Response
application/json
{ "apiversion": 3, "func": "generate_mailman_otp", "module": "Email", "result": { "data": "LfFYLPRT_UoS4EDi9lGKuOFK8FaWQsozzPYn8WjM3", "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
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.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_lists_total_disk_usage
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_lists_total_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_lists_total_disk_usageResponse
application/json
{ "apiversion": 3, "func": "get_lists_total_disk_usage", "module": "Email", "result": { "data": 1024, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }