# cPanel API 2 Functions - RoR::addapp

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function adds a Ruby application.

div
Warning:

- We **deprecated** the legacy Ruby codebase. For more information, read our [cPanel Deprecation Plan](https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-deprecation-plan/) documentation.
  - To install Ruby and create Ruby web applications, follow the directions in our [How to Create Ruby Web Applications](https://docs.cpanel.net/knowledge-base/web-services/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](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username RoR addapp appname=Test env=0 loadonboot=0 path=test
```

div
Notes:
br
- 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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
appname
td
em
string
td
p
strong
Required
p
The Ruby application's name.
td
p
A valid string.
td
code
Test
tr
td
code
env
td
em
Boolean
td
p
Whether to use the development or production environment.
p
This value defaults to 
code
1
.
td
ul
li
code
1
 — Production.
li
code
0
 — Development.
td
code
1
tr
td
code
path
td
em
string
td
p
strong
Required
p
The path to the Ruby application.
td
p
A valid file path, relative to the cPanel account's home directory.
p
div
Note:
    
p
span
You 
strong
cannot
 specify an already-installed Ruby application's directory.
td
code
test
tr
td
code
loadonboot
td
em
Boolean
td
p
Whether to load the application on boot.
p
This value defaults to 
code
0
.
td
ul
li
code
1
 — Load on boot.
li
code
0
 — Do 
strong
not
 load on boot.
td
code
0
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
installdetails
td
em
string
td
The Ruby application's installation details.
td
A valid string.
td
code
  exists  \n      create  app/controllers\n      create  app/helpers\n      create  app/models\n
    
p
tr
td
code
env
td
em
string
td
p
Whether to use the development or production environment.
td
ul
li
code
production
li
code
development
td
code
production
tr
td
code
statusmsg
td
em
string
td
Ruby's status.
td
ul
li
code
New Settings Saved
li
code
error
td
code
New Settings Saved
tr
td
code
status
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
0
tr
td
code
name
td
em
string
td
The Ruby application's name.
td
A valid string.
td
code
Test
tr
td
code
path
td
em
string
td
The path to the Ruby application.
td
A valid string.
td
code
test
tr
td
code
port
td
em
integer
td
The Ruby application's port number.
td
A positive integer.
td
code
12002
tr
td
code
loadonboot
td
em
Boolean
td
Whether to load the application on boot.
td
ul
li
code
1
 — Load on boot.
li
code
0
 — Do 
strong
not
 load on boot.
td
code
0
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1