Description

This function searches the home directory for Ruby applications to import into Ruby's database.

Examples




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



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Searches the home directory for Ruby apps and.... my.... preciousssssss!
$import_alltheruby = $cpanel->api2(
    'RoR', 'importrails'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Searches the home directory for Ruby apps and.... my.... preciousssssss!
my $import_alltheruby = $cpliveapi->api2(
    'RoR', 'importrails',
);

 




cpapi2 --user=username RoR importrails



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "importrails",
    "data": [
      1
    ],
    "event": {
      "result": 1
    },
    "module": "RoR"
  }
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
dataBoolean

Whether the function installed new applications.

  • 1 — Installed new applications.
  • 0 — Did not install new applications.
1
reasonstring

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.
resultBoolean

Whether the function succeeded.

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