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 number of email filters for every email address on a cPanel account.
Important:
When you disable the Receive Mail role or the IP Blocker feature, the system disables this function. For more information, read our How to Use Server Profiles documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/count_filters
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/count_filters
- 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/count_filtersResponse
application/json
{ "apiversion": 3, "func": "count_filters", "module": "Email", "result": { "data": 1, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function deletes an email filter.
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/delete_filter
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/delete_filter
- 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/delete_filter?account=user%40example.com&filtername=coffee'Response
application/json
{ "apiversion": 3, "func": "delete_filter", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function disables an email filter.
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/disable_filter
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/disable_filter
- 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/disable_filter?account=user%40example.com&filtername=coffee'Response
application/json
{ "apiversion": 3, "func": "disable_filter", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }