cPanel API 2 Functions - RoR::listapps

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function lists all of the cPanel account's Ruby on Rails applications.

Warning:

We deprecated the legacy Ruby codebase. For more information, read our cPanel Deprecation Plan documentation.
- To install Ruby and create Ruby web applications, follow the directions in our How to Create Ruby Web Applications documentation.
- To register and manage Ruby applications, use the functions in UAPI PassengerApps module functions.

Important:

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

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=RoR&cpanel_jsonapi_func=listapps

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List Ruby apps
$list_ruby = $cpanel->api2(
    'RoR', 'listapps'
);

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List Ruby apps
my $list_ruby = $cpliveapi->api2(
    'RoR', 'listapps',
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username RoR listapps

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listapps",
    "data": [
      {
        "env": "development",
        "name": "Test",
        "path": "/rails_apps/Test",
        "running": 1,
        "port": "12001",
        "pid": "18613",
        "production": 0,
        "loadonboot": "0"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "RoR"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
`env`	string	The application's environment.	`development` `production`	`development`
`name`	string	The application's name.	A valid string.	`Test`
`path`	string	The application's file path.	A valid file path, relative to the cPanel account's home directory,	`/rails_apps/Test`
`running`	Boolean	Whether the application is currently active.	`1` — Active. `0` — Inactive.	`1`
`port`	integer	The application's port number.	A positive integer.	`12001`
`pid`	integer	The application's process ID.	A positive integer.	`18613`
`production`	Boolean	Whether the application is in production or development mode.	`1` — Production. `0` — Development.	`0`
`loadonboot`	Boolean	Whether to load the application on boot.	`1` — Load application on boot. `0` — Do not load application on boot.	`0`
`reason`	string	A reason for failure. This function only returns a `reason` value if it failed.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`