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 application's feature name. This value must match a feature's app_key value. For a list of app_key values, read our Guide to cPanel Interface Customization - Appkeys documentation.
Example: app_key=boxtrapper
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Branding/get_application_information
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Branding/get_application_information
- 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/Branding/get_application_information?app_key=boxtrapper'Response
application/json
{ "apiversion": 3, "func": "get_application_information", "module": "Branding", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
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
- 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/Branding/get_applications?app_keys=addon_domains%2Cftp_accounts%2Canonymous_ftp'Response
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
- 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/Branding/get_available_applications?nvarglist=pref%2Csoftware%2Cdomains'Response
application/json
{ "apiversion": 3, "func": "get_available_applications", "module": "Branding", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }