Description

This function stops a Ruby application.

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=stopapp&appname=InTheNameOfLove



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Stop the Ruby app "InTheNameOfLove"
$stop_beforeyoubreakmyheart = $cpanel->api2(
    'RoR', 'stopapp',
 array(
        'appname' => 'InTheNameOfLove',
 )  
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Stop the Ruby app "InTheNameOfLove"
my $stop_beforeyoubreakmyheart = $cpliveapi->api2(
    'RoR', 'stopapp',
{ 
        'appname' => 'InTheNameOfLove',
   }
);

 




cpapi2 --user=username RoR stopapp appname=InTheNameOfLove



{
  "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"
  }
}



   

Parameters

ReturnTypeDescriptionPossible valuesExample
appnamestring

Required

The Ruby application's name.

A valid string.

InTheNameOfLove

Returns

ReturnTypeDescriptionPossible valuesExample
statusmsgstringRuby's status.
  • stop ok
  • error
stop 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 TERM to Mongrel at PID 18613...Done.\n
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