cPanel API 2 Modules - RoR
Warning:
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Introduction
The RoR
module manages Ruby on Rails®.
Important:
- 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.
- When you enable a non- Standard Node server profile, the system disables API calls associated with that profile's disabled roles.
Available functions
-
cPanel API 2 Functions -
RoR::addapp
— This function adds a Ruby application. -
cPanel API 2 Functions -
RoR::changeapp
— This function changes a Ruby application's details. -
cPanel API 2 Functions -
RoR::importrails
— This function searches the home directory for Ruby applications to import into Ruby's database. -
cPanel API 2 Functions -
RoR::listapps
— This function lists all of the cPanel account's Ruby on Rails applications. -
cPanel API 2 Functions -
RoR::listrewrites
— This function lists all of the mod_rewrite changes for the account's Ruby on Rails application. -
cPanel API 2 Functions -
RoR::needsimport
— This function checks whether the server configured Ruby for the authenticated cPanel account. -
cPanel API 2 Functions -
RoR::removeapp
— This function removes a Ruby application. -
cPanel API 2 Functions -
RoR::removerewrite
— This function removes a rewrite from a Ruby application. -
cPanel API 2 Functions -
RoR::restartapp
— This function restarts a Ruby application. -
cPanel API 2 Functions -
RoR::setuprewrite
— This function adds a rewrite for a Ruby application. -
cPanel API 2 Functions -
RoR::softrestartapp
— This function soft restarts a Ruby application. -
cPanel API 2 Functions -
RoR::startapp
— This function starts a Ruby application. -
cPanel API 2 Functions -
RoR::stopapp
— This function stops a Ruby application.