CPcpanel
PassengerApps
Application Manager

Return Passenger applications

Note: Web Apps (WebApp) is the newer, recommended feature for deploying web applications; it deploys container-based applications and supersedes Application Manager. Use WebApp::list instead of this function for applications deployed with Web Apps. Use PassengerApps only to manage applications already registered with Application Manager.

This function lists an account’s Passenger applications.

Important:

When you disable the Web Server role, the system disables this function.

get/PassengerApps/list_applications

Request

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

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": "list_applications",
  "module": "PassengerApps",
  "result": {
    "data": {
      "Name of Application 1": {
        "base_uri": "/app1-uri",
        "deployment_mode": "production",
        "deps": {
          "gem": "0",
          "npm": "0",
          "pip": "cd /home/user/app1-dir && pip install --user -r requirements.txt"
        },
        "domain": "example.com",
        "enabled": 1,
        "envvars": {},
        "name": "Name of Application 1",
        "path": "/home/user/app1-dir"
      },
      "Name of Application 2": {
        "base_uri": "/app2-uri",
        "deployment_mode": "development",
        "deps": {
          "gem": "cd /home/user/app2-dir && BUNDLE_PATH=~/.gem /path/to/ruby/version/package/bundler install",
          "npm": "0",
          "pip": "0"
        },
        "domain": "example.com",
        "enabled": 1,
        "envvars": {},
        "name": "Name of Application 2",
        "path": "/home/user/app2-dir"
      }
    },
    "status": 1
  }
}

Changes

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