cPanel API 2 Functions - LangMods::getprefix

Description

This function retrieves a cPanel-supported scripting language module's base directory.

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=LangMods&cpanel_jsonapi_func=getprefix&lang=perl

 LiveAPI PHP Class

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Retrieve base directory for perl on example.com.
my $get_base_dir $cpliveapi->api2(
    'LangMods''getprefix',
        array(
        'lang'          => 'perl',
        )
  );

 LiveAPI Perl Module

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve base directory for perl on example.com.
$get_base_dir $cpanel->api2(
    'LangMods''getprefix',
    {
        'lang'      => 'perl',
    }
 );

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI 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 our Deprecated 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":"pre_run",
      "data":[ 
         
            "status":1,
            "prefix":"/home/user/perl"
         }
      ],
      "event":{ 
         "result":1
      },
      "module":"LangMods"
   }
}

 

Note:

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

 

Parameters

 Parameter 

 Type 

Description

Possible values

 Example 

 lang

 string 

 Required

 The scripting language's short name. 

 An available scripting language.

 Note:

 The LangMods::langlist function returns possible values. 

 

 perl

 

 

Returns

 Return 

Type

Description

Possible values

Example

 status

 boolean

 Whether the function succeeded.

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

 1

 prefix

 string

 The module's base directory.

 A filepath, relative to the /home directory. 

 /home/user/perl

 reason

 string

 A reason for failure.

 Note:

 This function only returns a reasonvalue if there was an error. 

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