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/delete_site_quality_user
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SiteQuality/delete_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/delete_site_quality_userResponse
application/json
{ "apiversion": 3, "func": "delete_site_quality_user", "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/get_all_scores
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SiteQuality/get_all_scores
- 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/get_all_scores?verbose=1'Response
application/json
{ "apiversion": 3, "func": "get_all_scores", "module": "SiteQuality", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function returns the long-lived application token used to authenticate with koality's authentication servers.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SiteQuality/get_app_token
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SiteQuality/get_app_token
- 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/get_app_tokenResponse
application/json
{ "apiversion": 3, "func": "get_app_token", "module": "SiteQuality", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }