Install Passenger application dependencies

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.

Authorizations:
query Parameters
app_path
required
string <path>

The application’s filepath.

Example: app_path=/home/example/my-app/
type
required
string

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.
Enum: "gem" "npm" "pip"
Example: type=npm

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  PassengerApps \
  ensure_deps \
  type='npm' \
  app_path='/home/example/my-app/'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "ensure_deps",
  • "module": "PassengerApps",
  • "result": {
    • "data": {
      • "sse_url": "/sse/UserTasks/00000000_5c6c8b18228a35/ensure_deps.log",
      • "task_id": "00000000/5c76ec5566332c"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}