BuycPanel Blog

BuycPanel Blog

Latest news and updates

Guide to the LiveAPI System

Posted by Allura on 26 09 2019.

cPanel is an interface that requires a complicated environment if you are willing to create a program inside it. The live API system has been created within the cPanel to provide the exact environment needed to create the required software. The software is are also termed as applications and form the spine of all the actions that you take in C panel, WHO and webmail. The software is are also termed as applications and form the spine of all the actions that you take in cPanel, WHO and webmail.

Going into the nuances, each of these live API systems Provides a simple and effective way for the code that you generate to interact locally with cPanel. The call functions in C panel, which are termed as cPanel API 1, API 2 and UAPI can we call from the socket using the live API system in which generates an environment for the same.

Some of the things to note when creating a live API system in cPanel are:

  • Each of the LiveAPI Class provides a somewhat common element to interact with cPanel and WHM.
  • In order for this to be implemented, the environment needs authentication from the actual user having all the necessary permissions. Hence, in many of the cases when the user does not have the required permissions, the calls will have an error when it is

LiveAPI Environments

Let us delve a little deeper and then find out about some of the live API environment is associated with cPanel and WHM.

  1. LiveAPI PHP Class: These provide the necessary environment required for the PHP class.
  2. LiveAPI Perl Module: similar to the above PHP class, the live API Perl module provides the necessary environment for the Perl-class.

One thing to note is that although cPanel does not provide A dedicated class for them, some of the languages still supporter include Python, JAVA and other languages through custom CGI wrappers.

There are however some requirements in order to create a class of file with certain extensions. Below are some of the class extension lists.

  •  PHP — .livephp or .live.php
  • Perl — .livepl or
  1. Ruby — .liverb or .live.rb
  2. Python — .livepy or
  3. CGI — .livecgi or .live.cgi


Note : You can use CGI with the LiveAPI Perl module. The root user must own CGI scripts, and the scripts must have 0755 file permissions.