Child pages
  • cPanel API 2 Functions - RoR::changeapp

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function changes a Ruby application's details.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIsLegacyRubyDeprecated
PageWithExcerptLIB:_Ruby via mod_passenger Warnings

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
 )  
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
 }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username RoR changeapp appname=Test env=0 newappname=TestNew newloadonboot=0

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "changeapp",
    "data": [
      {
        "statusmsg": "New Settings Saved",
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "RoR"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

   


Parameters

ParameterTypeDescriptionPossible valuesExample
appnamestring

Required

The Ruby application's name.

A valid string.

Test
envBoolean

Whether to use the development or production environment.

Note
titleNote:

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
titleNote:

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
titleNote:

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
titleNote:

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