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 Examples:
The feature(s) for which to return configuration keys.
Note:
- Pass multiple
itemparameters to return multiple features' configuration keys. - If an
itemparameter returns anundefinedkey value, the configuration value does not exist or is set tonull.
Return the key1 configuration key for the cpanel feature.
Return the nested key3.subkey1 configuration key for the webmail feature.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Leika/leika_get_config
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Leika/leika_get_config
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi Leika leika_get_config item='key1' item='key3'
uapi --output=jsonpretty \
--user=username \
Leika \
leika_get_config \
item=cpanel.key1 \
item=webmail.key3Response
application/json
{ "apiversion": 3, "func": "leika_get_config", "module": "Leika", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/UserManager/change_password
- A server running cPanel.
https://cpanel-server.tld:2083/execute/UserManager/change_password
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
UserManager \
change_password \
oldpass='MyPreviousPassword' \
newpass='MyUpdatedPassword'Response
application/json
{ "apiversion": 3, "func": "change_password", "module": "UserManager", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Query
Whether to use Digest Authentication.
1- Use Digest Auth.0- Do not use Digest Auth.
Note:
- Windows® Vista, Windows® 7, Windows® 8, and Windows® 10 require that you use Digest Authentication in order to access your Web Disk over a clear text, unencrypted connection.
Default "The previously-set value or 0"
Enum01
Example: enabledigest=0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Users/change_password
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Users/change_password
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Users \
change_password \
oldpass='MyPreviousPassword' \
newpass='MyUpdatedPassword'Response
application/json
{ "apiversion": 3, "func": "change_password", "module": "Users", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }