cPanel API 2 Functions - RoR::removeapp - Knowledgebase

Description

This function removes 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=removeapp&appname=Test

 LiveAPI PHP Class

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

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
#  Delete the Ruby app "Test"
my $delete_rubyapp = $cpliveapi->api2(
    'RoR', 'removeapp',
{
        '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": "!!! PID file log\/mongrel.pid does not exist.  Not running?\nmongrel::stop reported an error. Use mongrel_rails mongrel::stop -h to get help.\n",
    "func": "removeapp",
    "data": [
      {
        "statusmsg": "App Removed",
        "env": "development",
        "status": 1,
        "loadonboot": "0",
        "name": "Test",
        "path": "/rails_apps/Test",
        "port": "12001"
      }
    ],
    "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
env	string	Whether the application was production or development.	production development	development
status	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1
loadonboot	boolean	Whether to load the function on system boot.	1 — Load on boot. 0 — Do not load on boot.	0
name	string	The application's name.	A valid string.	Test
path	string	The application's path.	A valid path.	/rails_apps/Test
port	integer	The application's port number.	A positive integer.	12001
reason	string	A reason for failure. Note: This function only returns a reason value 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