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/SiteQuality/has_site_quality_user
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SiteQuality/has_site_quality_user
- 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/SiteQuality/has_site_quality_userResponse
application/json
{ "apiversion": 3, "func": "has_site_quality_user", "module": "SiteQuality", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function verifies that koality has enabled the cPanel user's Site Quality Monitoring account.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SiteQuality/is_site_quality_user_enabled
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SiteQuality/is_site_quality_user_enabled
- 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/SiteQuality/is_site_quality_user_enabledResponse
application/json
{ "apiversion": 3, "func": "is_site_quality_user_enabled", "module": "SiteQuality", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function will remove Site Quality Monitoring account data from the cPanel user's configuration.
Note:
- This function will prevent cPanel & WHM from automatically logging the user into their Site Quality Monitoring account.
- This function does not delete the Site Quality Monitoring account from the koality servers.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SiteQuality/reset_config
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SiteQuality/reset_config
- 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/SiteQuality/reset_configResponse
application/json
{ "apiversion": 3, "func": "reset_config", "module": "SiteQuality", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }