cPanel API 2 Functions - RoR::restartapp

Description

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

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

 

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.

 HeyLittleSister 

 

Returns

Return

Type

Description

Possible values

Example

statusmsg

string

Ruby's status.

  • restart ok
  • error

restart ok

status

 boolean 

Whether the function succeeded.

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

0

 mongrel_stderr 

string

A reason for failure.

An error message.

 

mongrel_stdout

string

Out put from the Ruby service.

 A valid string that contains the process ID. 

 Sending USR2 to Mongrel at PID 6748...Done.\n 

reason

string

A reason for failure.

Note:

This function only returns a reasonvalue 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
Was this answer helpful?

Related Articles

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....