Child pages
  • UAPI Functions - PassengerApps::disable_application
Skip to end of metadata
Go to start of metadata

Description

This function disables a Ruby application on an account.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/PassengerApps/disable_application?name=slippers


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Disable the slippers application on the cPanel account.
$poll = $cpanel->uapi(
    'PassengerApps', 'disable_application',
    array(
        'name' => 'slippers',
  )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
#  Disable the slippers application on the cPanel account.
my $poll = $cpliveapi->uapi(
    'PassengerApps', 'disable_application',
    {
        'name'    => 'slippers',
  }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- Disable the slippers application on the cPanel account. -->
[% execute('PassengerApps', 'disable_application', { 'name' => 'slippers', } ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username PassengerApps disable_application name="slippers"


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{ 
    "data": null,
    "errors": null,
    "messages": null,
    "metadata": {},
    "status": 1
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

Required

The application to disable.

A valid Ruby application on the account.slippers

Returns

This function only returns metadata.