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 cancels a scan that you start with the WordPressInstanceManager::start_scan function.
Note:
You must install the WordPress Manager cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressInstanceManager/cancel_scan
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/cancel_scan
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
WordPressInstanceManager \
cancel_scanResponse
application/json
{ "apiversion": 3, "func": "cancel_scan", "module": "WordPressInstanceManager", "result": { "data": 0, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function updates a WordPress® cPAddon instance's administrator password.
Note:
You must install the WordPress Manager cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressInstanceManager/change_admin_password
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/change_admin_password
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
WordPressInstanceManager \
change_admin_password \
id='cPanel__Blogs__WordPressX.0.1491917088' \
password='luggage12345'Response
application/json
{ "apiversion": 3, "func": "change_admin_password", "module": "WordPressInstanceManager", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function cleans up the scan log file after you complete a scan with the WordPressInstanceManager::start_scan function. To read more information about the complete scan process, read our UAPI Functions - WordPressInstanceManager::start_scan documentation.
Note:
You must install the WordPress Manager cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressInstanceManager/cleanup_scan
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/cleanup_scan
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
WordPressInstanceManager \
cleanup_scan \
guid='B3A27B96-51F7-11E8-92E3-CC90C4F823F0'Response
application/json
{ "apiversion": 3, "func": "cleanup_scan", "module": "WordPressInstanceManager", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }