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 all of the cPanel account's domains that use domain-level filters.
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/list_filters_backups
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/list_filters_backups
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
list_filters_backupsResponse
application/json
{ "apiversion": 3, "func": "list_filters_backups", "module": "Email", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function retrieves a .yaml.gz file that contains system-level filter information.
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/list_system_filter_info
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/list_system_filter_info
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
list_system_filter_infoResponse
application/json
{ "apiversion": 3, "func": "list_system_filter_info", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function modifies the filter order for an email address. For more information about Exim filters, read Exim's documentation.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
Query
A mail filter name.
For each mail filter to reorder, supply a filter* parameter, where * is a number that represents the filter's order.
For example, to set coffee as the first email filter and cheesecloth as the second, set coffee as the filter1 parameter's value, and cheesecloth as the value for the filter2 parameter.
Example: filter*=coffee
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/reorder_filters
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/reorder_filters
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Email \
reorder_filters \
mailbox='user@example.com' \
filter*='coffee'Response
application/json
{ "apiversion": 3, "func": "reorder_filters", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }