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 available themes.
Note:
The /usr/local/cpanel/scripts/modify_accounts script allows you to modify the style and theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Themes/list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Themes/list
- 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/Themes/list?show_mail_themes=1'Response
application/json
{ "apiversion": 3, "func": "list", "module": "Themes", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function applies a new theme to the cPanel interface.
Note:
The /usr/local/cpanel/scripts/modify_accounts script allows you to modify the theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Themes/update
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Themes/update
- 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/Themes/update?theme=jupiter'Response
application/json
{ "apiversion": 3, "func": "update", "module": "Themes", "result": { "data": {}, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Themes/get_theme_base
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Themes/get_theme_base
- 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/Themes/get_theme_baseResponse
application/json
{ "apiversion": 3, "func": "get_theme_base", "module": "Themes", "result": { "data": "jupiter", "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }