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/
Query
The domain for which to return error log entries.
Example: domain=example.com
The Apache log file to query. This parameter defaults to error.
error- The/var/log/apache2/error_logfile.suexec- The/var/log/apache2/suexec_logfile.
Enum"error""suexec"
Example: log=suexec
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Stats/get_site_errors
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Stats/get_site_errors
- 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/Stats/get_site_errors?domain=example.com&log=suexec&maxlines=250'Response
application/json
{ "apiversion": 3, "func": "get_site_errors", "module": "Stats", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Stats/list_sites
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Stats/list_sites
- 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/Stats/list_sites?engine=webalizer&traffic=http'Response
application/json
{ "apiversion": 3, "func": "list_sites", "module": "Stats", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Stats/list_stats_by_domain
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Stats/list_stats_by_domain
- 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/Stats/list_stats_by_domain?domain=example.com&engine=analog&ssl=1'Response
application/json
{ "apiversion": 3, "func": "list_stats_by_domain", "module": "Stats", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }