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 retrieves the Apache SpamAssassin™ settings for the account.
Important:
When you disable the SpamFilter role, the system disables this function.
Security
BasicAuth
Query
Retrieve a specific user account's SpamAssassin settings.
Note:
If you do not specify this parameter, the function returns the settings for the default email account.
Example: account=username@example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_spam_settings
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_spam_settings
- 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/get_spam_settings?account=username%40example.com'Response
application/json
{ "apiversion": 3, "func": "get_spam_settings", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SpamAssassin/clear_spam_box
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SpamAssassin/clear_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/SpamAssassin/clear_spam_boxResponse
application/json
{ "apiversion": 3, "func": "clear_spam_box", "module": "SpamAssassin", "result": { "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SpamAssassin/get_symbolic_test_names
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SpamAssassin/get_symbolic_test_names
- 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/SpamAssassin/get_symbolic_test_namesResponse
application/json
{ "apiversion": 3, "errors": null, "func": "get_symbolic_test_names", "messages": null, "module": "SpamAssassin", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null }, "status": null }