Knowledgebase

Introduction

The LiveAPI System provides environments for applications in cPanel's x3 theme. Each environment provides a way for your code to interact locally with the cPanel binary, cpsrvd . This allows you to make cPanel API 1, cPanel API 2, and UAPI function calls via the socket.

• Each LiveAPI class provides common elements to integrate with cPanel & WHM. 
• When you use these environments, the authenticated user executes the functions. Because of this, calls may fail if the authenticated user does not have adequate permissions.

LiveAPI environments

cPanel & WHM provides the following classes for the LiveAPI system:

• The LiveAPI PHP Class — The LiveAPI PHP Class provides an environment for PHP applications.
• The LiveAPI Perl Module — The LiveAPI Perl Module provides an environment for Perl applications.

While cPanel does not currently provide classes for them, the LiveAPI system also supports the following languages:

• Ruby
• Python
• Other languages, through custom CGI wrappers.

Requirements

Applications that use a LiveAPI environment must meet the following requirements:

• The code must include the appropriate environment and instantiate the respective class's object.
• File names must end with the appropriate file extension:
  • PHP — .livephp or .live.php
  • Perl — .livepl or .live.pl
  • Ruby — .liverb or .live.rb
  • Python — .livepy or .live.py
  • CGI — .livecgi or .live.cgi
• Files, or symlinks to the relevant files, must exist in the /usr/local/cpanel/base/frontend/theme/ directory, where theme is the cPanel theme (x3 or paper_lantern).