CPcpanel
PassengerApps
Application Manager

Install Passenger application dependencies

Note: Web Apps (WebApp) is the newer, recommended feature for deploying web applications; it deploys container-based applications and supersedes Application Manager. WebApp::deploy installs an application's dependencies automatically as part of the deploy, so there is no separate dependency-install call for Web Apps. Use PassengerApps only to manage applications already registered with Application Manager.

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.

get/PassengerApps/ensure_deps

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

app_pathstring path required
Example:/home/example/my-app/

The application’s filepath.

type'gem' | 'npm' | 'pip' required
Example:npm

The application’s type.

  • gem — Ensure ruby gems in the application’s Gemfile file.
  • npm — Ensure node packages in the application’s package.json file.
  • pip — Ensure python pips in the application’s requirements.txt file.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "ensure_deps",
  "module": "PassengerApps",
  "result": {
    "data": {
      "sse_url": "/sse/UserTasks/00000000_5c6c8b18228a35/ensure_deps.log",
      "task_id": "00000000/5c76ec5566332c"
    },
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.