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/
Query
The domain to query. If you do not use this parameter, the function lists mailing lists for all of the cPanel account's domains.
Example: domain=example.com
A Perl Compatible Regular Expression (PCRE) that filters the results.
Example: regex=user
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/list_lists
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/list_lists
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
list_listsResponse
application/json
{ "apiversion": 3, "func": "list_lists", "module": "Email", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function changes a mailing list's password.
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/passwd_list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/passwd_list
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
passwd_list \
list='mylist@example.com' \
password='12345luggage'Response
application/json
{ "apiversion": 3, "func": "passwd_list", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/remove_mailman_delegates
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/remove_mailman_delegates
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
remove_mailman_delegates \
list='mylist' \
delegates='user@example.com,admin@example.com'Response
application/json
{ "apiversion": 3, "func": "remove_mailman_delegates", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }