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 deletes a Web Disk account.
Important:
When you disable the Web Disk role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WebDisk/delete_user
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WebDisk/delete_user
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
WebDisk \
delete_user \
user='example1@example.com' \
destroy='1'Response
application/json
{ "apiversion": 3, "func": "delete_user", "module": "WebDisk", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function changes the home directory for a Web Disk account.
Important:
When you disable the Web Disk role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WebDisk/set_homedir
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WebDisk/set_homedir
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
WebDisk \
set_homedir \
user='example1@example.com' \
homedir='example1/'Response
application/json
{ "apiversion": 3, "func": "set_homedir", "module": "WebDisk", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function changes the Web Disk account's password.
Important:
When you disable the Web Disk role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WebDisk/set_password
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WebDisk/set_password
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
WebDisk \
set_password \
user='example1@example.com' \
password='123456luggage'Response
application/json
{ "apiversion": 3, "func": "set_password", "module": "WebDisk", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }