Return Passenger applications

This function lists an account’s Passenger applications.

Important:

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

SecurityBasicAuth
Responses
200

HTTP Request was successful.

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
get/PassengerApps/list_applications
Request samples
uapi --output=jsonpretty \
  --user=username \
  PassengerApps \
  list_applications
Response samples
application/json
{
  • "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"
        }
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}