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 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 } }
Request
This function registers a Passenger application for an account.
Important:
- This function only registers an application. It does not create the application. You must create an application before you register the application. For an example of how to do this, read our How to Create Ruby Web Applications documentation.
- When you disable the Web Server role, the system disables this function.
Security
BasicAuth
Query
The domain for which to register the application.
Example: domain=dorothy.com
The application’s filepath relative to the user’s home directory.
Example: path=/slippers
The type of server environment in which to run the application.
development— Sets the application to run in a development environment.production— Sets the application to run in a production environment.
Default "production"
Enum"production""development"
Example: deployment_mode=production
Whether to enable the application and generate the web server configuration for it.
1— Enable the application and generate the web server configuration.0— Don’t enable the application and generate the web server configuration.
Default 1
Enum01
Example: enabled=1
Environment variables that the application needs.
Note:
For each envvar_name parameter you send, you must include an envvar_value parameter.
This parameter's value can only contain letters, numbers, underscores, and dashes, and cannot begin with a number. This parameter's value must also not exceed 256 characters.
Example: envvar_name=SHOES&envvar_name=TINMAN
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/PassengerApps/register_application
- A server running cPanel.
https://cpanel-server.tld:2083/execute/PassengerApps/register_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/register_application?domain=dorothy.com&name=Name+of+Application&path=%2Fslippers&base_uri=%2Fruby&deployment_mode=production&enabled=1&envvar_name=SHOES%2CTINMAN&envvar_value=ruby%2Cheart'Response
application/json
{ "apiversion": 3, "func": "register_application", "module": "PassengerApps", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }