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 disables Apache SpamAssassin™ for a cPanel account.
Important:
When you disable the Spam Filter role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/disable_spam_assassin
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/disable_spam_assassin
- 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_spam_assassinResponse
application/json
{ "apiversion": 3, "func": "disable_spam_assassin", "module": "Email", "result": { "data": null, "errors": null, "messages": [ … ], "metadata": {}, "status": 1, "warnings": null } }
Request
This function disables the Apache SpamAssassin™ auto-delete spam feature.
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_spam_autodelete
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/disable_spam_autodelete
- 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_spam_autodeleteResponse
application/json
{ "apiversion": 3, "func": "disable_spam_autodelete", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function disables spam box filtering for a cPanel account. When you disable spam box filtering, the system sends all messages to the account's inbox.
Notes:
- This function requires that your hosting provider enables Apache SpamAssassin™ on the server.
- To enable spam box filtering, use the UAPI
Email::enable_spam_boxfunction. - For more information, read our Spam Filters documentation.
Important:
When you disable the Spam Filter role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/disable_spam_box
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/disable_spam_box
- 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_spam_boxResponse
application/json
{ "apiversion": 3, "func": "disable_spam_box", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }