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/
- 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
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
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
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
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 }
Request
This function lists the Apache SpamAssassin™ settings for the account.
Note:
Additional customizations may appear in the returns. Form more information read the Apache SpamAssassin™ configuration file documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SpamAssassin/get_user_preferences
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SpamAssassin/get_user_preferences
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
SpamAssassin \
get_user_preferencesResponse
application/json
{ "apiversion": 3, "func": "get_user_preferences", "module": "SpamAssassin", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }