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 checks the status of a completed scan and reports the results. To find more information about the scan process, read our UAPI documentation for WordPressInstanceManager::start_scan.
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/get_scan_results
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/get_scan_results
- 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/get_scan_resultsResponse
application/json
{ "apiversion": 3, "func": "get_scan_results", "module": "WordPressInstanceManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressInstanceManager/is_installable_addon_available
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/is_installable_addon_available
- 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/is_installable_addon_availableResponse
application/json
{ "apiversion": 3, "func": "is_installable_addon_available", "module": "WordPressInstanceManager", "result": { "data": 1, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function scans for WordPress® instances installed on a cPanel account. The system will populate cPanel's WordPress Manager interface with any newly discovered instances.
Note:
You must install the WordPress Manager cPanel plugin to access this API function.
This function uses the following SSE events:
register— The scan operation discovered a WordPress instance and registered it. The data is a JSON-encoded object containing the attributes of the instance, with the same format used in the UAPIget_instancesand UAPIget_instance_by_idfunctions.found— The scan operation found a WordPress instance. If the WordPress instance is newly discovered, the system will also generate aregisterevent for the instance. The data is a JSON-encoded object containing the following:path— The absolute file path to the instance.
done— The scan is finished. The data is a JSON-encoded object that contains:found— An array of strings that represents the absolute path to the discovered instances and any instances that the system already registered.converted— An array of converted instances that the system returns in the same format provided in the UAPIget_instancesand UAPIget_instance_by_idfunctions.
terminated— The system or user terminated the scan.timedout— The scan timed out before it completed.register-failed— The system failed to build the instance registry. The data is a JSON-encoded string that contains the error message.register-load-failed— The system could not load the registry after building the instance registry. The data is a JSON-encoded string that contains the error message.
For more information about server sent events, read Mozilla's Using server-sent events documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WordPressInstanceManager/start_scan
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WordPressInstanceManager/start_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/start_scanResponse
application/json
{ "apiversion": 3, "func": "start_scan", "module": "WordPressInstanceManager", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }