cPanel API 2 Functions - RoR::softrestartapp - Knowledgebase

Description

This function soft restarts a Ruby application.

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=softrestartapp&appname=Test

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Soft restarts the Ruby app "Test"
$softrestart_rubyapp = $cpanel->api2(
    'RoR', 'softrestartapp',
 array(
        'appname' => 'Test',
 ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Soft restarts the Ruby app "Test"
my $softrestart_rubyapp = $cpliveapi->api2(
    'RoR', 'softrestartapp',
{
        'appname' => 'Test',
   }
);

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.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "error": "invalid option: -s for command 'mongrel::stop'\nTry mongrel::stop -h to get help.\n",
    "func": "softrestartapp",
    "data": [
      {
        "statusmsg": "softrestart ok",
        "status": 0,
        "mongrel_stderr": "invalid option: -s for command 'mongrel::stop'\nTry mongrel::stop -h to get help.\n",
        "mongrel_stdout": ""
      }
    ],
    "event": {
      "result": 1
    },
    "module": "RoR"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Return	Type	Description	Possible values	Example
appname	string	Required The Ruby application's name.	A valid string.	Test

Return

Type

Description

Possible values

Example

appname

string

Required

The Ruby application's name.

A valid string.

Test

Returns

Return	Type	Description	Possible values	Example
statusmsg	string	Ruby's status.	remove ok error	remove ok
status	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1
mongrel_stderr	string	Any errors from Ruby.	A valid string.	invalid option: -s for command 'mongrel::stop'\nTry mongrel::stop -h to get help.\n
mongrel_stdout	string	Ruby's output.	A valid string.
reason	string	A reason for failure. Note: This function only returns areasonvalue 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

Knowledgebase

Categories

Categories