Child pages
  • cPanel API 2 Functions - RoR::addapp
Skip to end of metadata
Go to start of metadata

Description

This function adds a Ruby application.

Warning:

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

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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:

  • In cPanel & WHM version 11.30 and later, 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 run the --user=username command.
  • 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      create  app/views/layouts\n      create  config/environments\n      create  config/initializers\n      create  config/locales\n      create  db\n      create  doc\n      create  lib\n      create  lib/tasks\n      create  log\n      create  public/images\n      create  public/javascripts\n      create  public/stylesheets\n      create  script/performance\n      create  test/fixtures\n      create  test/functional\n      create  test/integration\n      create  test/performance\n      create  test/unit\n      create  vendor\n      create  vendor/plugins\n      create  tmp/sessions\n      create  tmp/sockets\n      create  tmp/cache\n      create  tmp/pids\n      create  Rakefile\n      create  README\n      create  app/controllers/application_controller.rb\n      create  app/helpers/application_helper.rb\n      create  config/database.yml\n      create  config/routes.rb\n      create  config/locales/en.yml\n      create  db/seeds.rb\n      create  config/initializers/backtrace_silencers.rb\n      create  config/initializers/inflections.rb\n      create  config/initializers/mime_types.rb\n      create  config/initializers/new_rails_defaults.rb\n      create  config/initializers/session_store.rb\n      create  config/initializers/cookie_verification_secret.rb\n      create  config/environment.rb\n      create  config/boot.rb\n      create  config/environments/production.rb\n      create  config/environments/development.rb\n      create  config/environments/test.rb\n      create  script/about\n      create  script/console\n      create  script/dbconsole\n      create  script/destroy\n      create  script/generate\n      create  script/runner\n      create  script/server\n      create  script/plugin\n      create  script/performance/benchmarker\n      create  script/performance/profiler\n      create  test/test_helper.rb\n      create  test/performance/browsing_test.rb\n      create  public/404.html\n      create  public/422.html\n      create  public/500.html\n      create  public/index.html\n      create  public/favicon.ico\n      create  public/robots.txt\n      create  public/images/rails.png\n      create  public/javascripts/prototype.js\n      create  public/javascripts/effects.js\n      create  public/javascripts/dragdrop.js\n      create  public/javascripts/controls.js\n      create  public/javascripts/application.js\n      create  doc/README_FOR_APP\n      create  log/server.log\n      create  log/production.log\n      create  log/development.log\n      create  log/test.log\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

ParameterTypeDescriptionPossible valuesExample
appnamestring

Required

The Ruby application's name.

A valid string.

Test
envBoolean

Whether to use the development or production environment.

This value defaults to 1.

  • 1 — Production.
  • 0 — Development.
1
pathstring

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
loadonbootBoolean

Whether to load the application on boot.

This value defaults to 0.

  • 1 — Load on boot.
  • 0 — Do not load on boot.
0

Returns

ReturnTypeDescriptionPossible valuesExample
installdetailsstringThe Ruby application's installation details.A valid string.
 Click to view

"      exists  \n      create  app/controllers\n      create  app/helpers\n      create  app/models\n      create  app/views/layouts\n      create  config/environments\n      create  config/initializers\n      create  config/locales\n      create  db\n      create  doc\n      create  lib\n      create  lib/tasks\n      create  log\n      create  public/images\n      create  public/javascripts\n      create  public/stylesheets\n      create  script/performance\n      create  test/fixtures\n      create  test/functional\n      create  test/integration\n      create  test/performance\n      create  test/unit\n      create  vendor\n      create  vendor/plugins\n      create  tmp/sessions\n      create  tmp/sockets\n      create  tmp/cache\n      create  tmp/pids\n      create  Rakefile\n      create  README\n      create  app/controllers/application_controller.rb\n      create  app/helpers/application_helper.rb\n      create  config/database.yml\n      create  config/routes.rb\n      create  config/locales/en.yml\n      create  db/seeds.rb\n      create  config/initializers/backtrace_silencers.rb\n      create  config/initializers/inflections.rb\n      create  config/initializers/mime_types.rb\n      create  config/initializers/new_rails_defaults.rb\n      create  config/initializers/session_store.rb\n      create  config/initializers/cookie_verification_secret.rb\n      create  config/environment.rb\n      create  config/boot.rb\n      create  config/environments/production.rb\n      create  config/environments/development.rb\n      create  config/environments/test.rb\n      create  script/about\n      create  script/console\n      create  script/dbconsole\n      create  script/destroy\n      create  script/generate\n      create  script/runner\n      create  script/server\n      create  script/plugin\n      create  script/performance/benchmarker\n      create  script/performance/profiler\n      create  test/test_helper.rb\n      create  test/performance/browsing_test.rb\n      create  public/404.html\n      create  public/422.html\n      create  public/500.html\n      create  public/index.html\n      create  public/favicon.ico\n      create  public/robots.txt\n      create  public/images/rails.png\n      create  public/javascripts/prototype.js\n      create  public/javascripts/effects.js\n      create  public/javascripts/dragdrop.js\n      create  public/javascripts/controls.js\n      create  public/javascripts/application.js\n      create  doc/README_FOR_APP\n      create  log/server.log\n      create  log/production.log\n      create  log/development.log\n      create  log/test.log\n

envstring

Whether to use the development or production environment.

  • production
  • development
production
statusmsgstringRuby's status.
  • New Settings Saved
  • error
New Settings Saved
statusBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
0
namestring

The Ruby application's name.

A valid string.Test
pathstringThe path to the Ruby application.A valid string.test
portintegerThe Ruby application's port number.A positive integer.12002
loadonbootBooleanWhether to load the application on boot.
  • 1 — Load on boot.
  • 0 — Do not load on boot.
0
reasonstring

A reason for failure.

Note:

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1