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
A comma-separated list of an application feature names. If you do not specify this parameter, the output will include all of the applications that the dynamicui.conf file contains.
Note:
- This value must match an application's
featurevalue in thedynamicui.conffile. - For more information, read our Guide to cPanel Interface Customization - Appkeys documentation.
Example: app_keys=addon_domains,ftp_accounts,anonymous_ftp
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Branding/get_applications
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Branding/get_applications
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Branding \
get_applicationsResponse
application/json
{ "apiversion": 3, "func": "get_applications", "module": "Branding", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Branding/get_available_applications
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Branding/get_available_applications
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Branding \
get_available_applicationsResponse
application/json
{ "apiversion": 3, "func": "get_available_applications", "module": "Branding", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Query
The absolute path to the directory containing the sitemap.json file. This is the path to your theme's document root.
Example: docroot=/usr/local/cpanel/base/webmail/jupiter
A comma-separated list of Appkey names. If you do not specify this parameter, the output will include all of the applications that the sitemap.json file contains.
Note:
This value must match an application's key value in the sitemap.json file. For more information, read our Guide to cPanel Interface Customization - Appkeys documentation.
Example: app_keys=email_filters
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Branding/get_information_for_applications
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Branding/get_information_for_applications
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Branding \
get_information_for_applications \
docroot='/usr/local/cpanel/base/webmail/jupiter'Response
application/json
{ "apiversion": 3, "func": "get_information_for_applications", "module": "Branding", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }