cPanel API 2 Functions - RoR::changeapp - Knowledgebase

Description

This function changes a Ruby application's details.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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

 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',
 ) 
);

 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',
 }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

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.

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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
appname	string	Required The Ruby application's name.	A valid string.	Test
env	Boolean	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
newappname	string	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
newloadonboot	Boolean	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

Return	Type	Description	Possible values	Example
statusmsg	string	Ruby's status.	· New Settings Saved · error	New Settings Saved
status	Boolean	Whether the function succeeded.	· 1 — The function succeeded. · 0 — The function failed.	0
reason	string	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.
result	Boolean	Whether the function succeeded.	· 1 — The function succeeded. · 0 — The function failed.	1

0 Users Found This Useful

The cPanel Interface

For cPanel & WHM version 58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article: Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....

Knowledgebase

Categories

Categories