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 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
- 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/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
- 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/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 } }
Request
This function configures a WordPress cPAddon instance's automatic updates settings. If you enable automatic updates for a legacy WordPress cPAddon instance, the function will convert it to use the RPM-based WordPress cPAddon.
Important:
This function changes the instance's automatic update setting in the wp-config.php file. Before you run this function, you should verify that a filter does not exist for the automatic update settings. Use the get_instance_by_id function and view the autoupdate.core.has_filter return to determine if a filter exists.
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/configure_autoupdate
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/configure_autoupdate
- 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/WordPressInstanceManager/configure_autoupdate?autoupdate.core.major=0&autoupdate.core.minor=0&id=cPanel__Blogs__WordPressX.0.1491917088'Response
application/json
{ "apiversion": 3, "func": "configure_autoupdate", "module": "WordPressInstanceManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }