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

Versions Compared

Key

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

Description

Excerpt

This function restarts a Ruby application.

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=restartapp&appname=HeyLittleSister

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Restart the Ruby app "HeyLittleSister" because it's a nice day to start again.
$restart_rubyapp = $cpanel->api2(
    'RoR', 'restartapp',
 array(
        'appname' => 'HeyLittleSister',
 )  
);

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.
 
# Restart the Ruby app "HeyLittleSister" because it's a nice day to start again.
my $restart_rubyapp = $cpliveapi->api2(
    'RoR', 'restartapp',
{ 
        'appname' => 'HeyLittleSister',
   }
);

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 restartapp appname=HeyLittleSister

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "stopapp",
    "data": [
      {
        "statusmsg": "stop ok",
        "status": 1,
        "mongrel_stderr": "",
        "mongrel_stdout": "Sending TERM to Mongrel at PID 18613...Done.\n"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "RoR"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ReturnTypeDescriptionPossible valuesExample
appnamestring

Required

The Ruby application's name.

A valid string.

HeyLittleSister

Returns

ReturnTypeDescriptionPossible valuesExample
statusmsgstringRuby's status.
  • restart ok
  • error
                restart ok
statusBoolean

Whether the function succeeded.

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

A reason for failure.

An error message. 
mongrel_stdoutstringOutput from the Ruby service.A valid string that contains the process ID.
Sending USR2 to Mongrel at PID 6748...Done.\n
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