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 lists the mail directory's subdirectories (boxes) and files.
Important:
When you disable the Receive Mail role, the system disables this function.
Notes:
If you do not use any input parameters, the function returns a list of items in the cPanel account's main mail directory.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/browse_mailbox
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/browse_mailbox
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
browse_mailboxResponse
application/json
{ "apiversion": 3, "func": "browse_mailbox", "module": "Email", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function returns the number of autoresponders for every email address on 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/count_auto_responders
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/count_auto_responders
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
count_auto_respondersResponse
application/json
{ "apiversion": 3, "func": "count_auto_responders", "module": "Email", "result": { "data": 1, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function returns the number of email accounts for 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/count_pops
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/count_pops
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
count_popsResponse
application/json
{ "apiversion": 3, "func": "count_pops", "module": "Email", "result": { "data": 1, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }