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

Description

This function changes a Ruby application's details.

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=changeapp&appname=Test&env=0&newappname=TestNew&newloadonboot=0


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.
 
// Changes the Ruby add "Test"
$change_app = $cpanel->api2(
    'RoR', 'changeapp',
 array(
        'appname'       => 'Test',
        'env'           => '0',
        'newappname'    => 'TestNew',
        'newloadonboot' => '0',
 )  
);


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.
 
# Changes the Ruby add "Test"
my $change_app = $cpliveapi->api2(
    'RoR', 'setuprewrite',
{ 
        'appname'       => 'Test',
        'env'           => '0',
        'newappname'    => 'TestNew',
        'newloadonboot' => '0',
 }
);


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 changeapp appname=Test env=0 newappname=TestNew newloadonboot=0


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": "changeapp",
    "data": [
      {
        "statusmsg": "New Settings Saved",
        "status": 1
      }
    ],
    "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.

Note:

If you do not use this parameter, the function retains the current value for the parameter.

  • 1 — Production.
  • 0 — Development.
1
newappnamestring

The Ruby application's new name.

Note:

If you do not use this parameter, the function retains the current value for the parameter.

A valid string.TestNew
newloadonbootBoolean

Whether to load the application on boot.

Note:

If you do not use this parameter, the function retains the current value for the parameter.

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

Returns

ReturnTypeDescriptionPossible valuesExample
statusmsgstringRuby's status.
  • New Settings Saved
  • error
New Settings Saved
statusBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
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