cPanel API 2 Functions - RoR::addapp

Warning:

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

Description

This function adds a Ruby application.

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=addapp&appname=Test&env=0&loadonboot=0&path=test

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.

// Add the Ruby app "Test"
$add_app = $cpanel->api2(
    'RoR', 'addapp',
 array(
        'appname'       => 'Test',
        'env'           => '0',
        'loadonboot'    => '0',
        'path'          => 'test',
 )  
);

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.

# Add the Ruby app "Test"
my $add_app = $cpliveapi->api2(
    'RoR', 'addapp',
{
        'appname'       => 'Test',
        'env'           => '0',
        'loadonboot'    => '0',
        'path'          => 'test',
 }
);

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 addapp appname=Test env=0 loadonboot=0 path=test

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": "addapp",
    "data": [
      {
        "installdetails": "      exists  \n      create  app/controllers\n      create  app/helpers\n      create  app/models\n    ",
        "statusmsg": "App Added",
        "env": "production",
        "status": 1,
        "name": "Test",
        "path": "/test",
        "port": "12002",
        "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

Parameter	Type	Description	Possible values	Example
`appname`	string	Required The Ruby application's name.	A valid string.	`Test`
`env`	Boolean	Whether to use the development or production environment. This value defaults to `1`.	`1` — Production. `0` — Development.	`1`
`path`	string	Required The path to the Ruby application.	A valid file path, relative to the cPanel account's home directory. Note: You cannot specify an already-installed Ruby application's directory.	`test`
`loadonboot`	Boolean	Whether to load the application on boot. This value defaults to `0`.	`1` — Load on boot. `0` — Do not load on boot.	`0`

Returns

Return	Type	Description	Possible values	Example
`installdetails`	string	The Ruby application's installation details.	A valid string.	`exists \n create app/controllers\n create app/helpers\n create app/models\n`
`env`	string	Whether to use the development or production environment.	`production` `development`	`production`
`statusmsg`	string	Ruby's status.	`New Settings Saved` `error`	`New Settings Saved`
`status`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`0`
`name`	string	The Ruby application's name.	A valid string.	`Test`
`path`	string	The path to the Ruby application.	A valid string.	`test`
`port`	integer	The Ruby application's port number.	A positive integer.	`12002`
`loadonboot`	Boolean	Whether to load the application on boot.	`1` — Load on boot. `0` — Do not load 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`