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 lists all of the backup files and directories in the user's home directory.
Important:
When you disable the File Storage role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Restore/directory_listing
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Restore/directory_listing
- 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/Restore/directory_listing?path=%2Fpublic_html%2F'Response
application/json
{ "apiversion": 3, "func": "directory_listing", "module": "Restore", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function lists a reseller's users that have existing backup metadata.
Note:
When you disable the File Storage role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Restore/get_users
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Restore/get_users
- 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/Restore/get_usersResponse
application/json
{ "apiversion": 3, "func": "get_users", "module": "Restore", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function lists all of an item's backup locations. An item can be a file, a directory, or a symlink.
Important:
When you disable the File Storage role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Restore/query_file_info
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Restore/query_file_info
- 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/Restore/query_file_info?path=%2Fpublic_html%2Findex.php&exists=0'Response
application/json
{ "apiversion": 3, "func": "query_file_info", "module": "Restore", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }