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 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 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SiteQuality/send_activation_email
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SiteQuality/send_activation_email
- 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/send_activation_emailResponse
application/json
{ "apiversion": 3, "func": "send_activation_email", "module": "SiteQuality", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function updates the domain name for a Site Quality Monitoring project. It searches through all projects owned by the user to find systems that match the specified old domain and updates them to use the new domain. This is typically used when a website's domain name changes and the monitoring configuration needs to be updated accordingly.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SiteQuality/update_domain
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SiteQuality/update_domain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SiteQuality/update_domain?new_domain=newdomain.com&old_domain=olddomain.com'Response
application/json
{ "apiversion": 3, "func": "update_domain", "module": "SiteQuality", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }