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 enables a Passenger application and generates the Apache configuration on an account.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/PassengerApps/enable_application
- A server running cPanel.
https://cpanel-server.tld:2083/execute/PassengerApps/enable_application
- 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/PassengerApps/enable_application?name=slippers'Response
application/json
{ "apiversion": 3, "func": "enable_application", "module": "PassengerApps", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function installs the dependencies for a Passenger application.
Note:
This function starts the installation process. This may take a long time to complete.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/PassengerApps/ensure_deps
- A server running cPanel.
https://cpanel-server.tld:2083/execute/PassengerApps/ensure_deps
- 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/PassengerApps/ensure_deps?app_path=%2Fhome%2Fexample%2Fmy-app%2F&type=npm'Response
application/json
{ "apiversion": 3, "func": "ensure_deps", "module": "PassengerApps", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function lists an account’s Passenger applications.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/PassengerApps/list_applications
- A server running cPanel.
https://cpanel-server.tld:2083/execute/PassengerApps/list_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/PassengerApps/list_applicationsResponse
application/json
{ "apiversion": 3, "func": "list_applications", "module": "PassengerApps", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }