DEV Community

Muhammad Hasnain
Muhammad Hasnain

Posted on

Introducing Laravel CPanel API - Simplify Your cPanel Integration!

πŸš€ Hey Laravel developers! Are you tired of dealing with complex cPanel integrations? Say hello to the Laravel CPanel API - a powerful library that streamlines your interactions with the cPanel API. Manage subdomains, databases, emails, and more with ease using this straightforward package. Save time and effort while boosting your productivity. Check it out now!

GitHub logo MHasnainJafri / cpanel

License Open Issues Stars Forks

Library Name: Laravel CPanel API

This library provides a convenient way to interact with the cPanel API using Laravel. It allows you to perform various cPanel functions such as creating subdomains, managing databases, handling email accounts, and managing disk usage.

Installation

To use this library in your Laravel project, you can install it via Composer. Run the following command in your terminal:


composer require mhasnainjafri/cpanel

Usage

To get started, you need to create a new instance of the Cpanel class. There are two ways to initialize the class:

  1. Without any parameters:
$cpanel = new Cpanel();
Enter fullscreen mode Exit fullscreen mode
  1. With parameters (if not defined in .env file):
$cpanel = new Cpanel($cpanel_domain, $cpanel_api_token, $cpanel_username, 'https', 2083);
Enter fullscreen mode Exit fullscreen mode

Alternatively, you can set the cPanel credentials in the .env file:

CPANEL_DOMAIN=domain e.g : xyz.com
CPANEL_PORT=cpanel port (mostly is) 2083
CPANEL_API_TOKEN= Cpanel api token (To get
…
View on GitHub

Installation

To use this library in your Laravel project, you can install it via Composer. Run the following command in your terminal:


composer require mhasnainjafri/cpanel
Enter fullscreen mode Exit fullscreen mode

Usage

To get started, you need to create a new instance of the Cpanel class. There are two ways to initialize the class:

  1. Without any parameters: 
$cpanel = new Cpanel();
Enter fullscreen mode Exit fullscreen mode
  1. With parameters (if not defined in .env file): 
$cpanel = new Cpanel($cpanel_domain, $cpanel_api_token, $cpanel_username, 'https', 2083);
Enter fullscreen mode Exit fullscreen mode

Alternatively, you can set the cPanel credentials in the .env file:

CPANEL_DOMAIN=domain e.g : xyz.com
CPANEL_PORT=cpanel port (mostly is) 2083
CPANEL_API_TOKEN= Cpanel api token (To get api token view step 3)
CPANEL_USERNAME= Cpanel username
Enter fullscreen mode Exit fullscreen mode
  1. ### Steps to get Cpanel Api
  • search api in cpanel search bar
  • click on Manage api token

![step 1]

Image description

  • Give token a name and click on create ![step 2]

Image description

  • Copy the token you get

Subdomain Functions

To create a subdomain, use the createSubDomain() method:


$cpanel->createSubDomain('Sub domain e.g: web', 'domain e.g: xyz.com', 'Path where subdomain points e.g: /home/domain/public_html/subdomain');
Enter fullscreen mode Exit fullscreen mode

Database Functions

To list all databases, use the listDatabases() method:


$cpanel->listDatabases();
Enter fullscreen mode Exit fullscreen mode

To create a new database, use the createDatabase() method:


$cpanel->createDatabase('Database Name');
Enter fullscreen mode Exit fullscreen mode

To delete a database, use the deleteDatabase() method:


$cpanel->deleteDatabase('Database Name');
Enter fullscreen mode Exit fullscreen mode

To create a database user, use the createDatabaseUser() method:


$cpanel->createDatabaseUser('Database username', 'password');
Enter fullscreen mode Exit fullscreen mode

To delete a database user, use the deleteDatabaseUser() method:


$cpanel->deleteDatabaseUser('Database username');
Enter fullscreen mode Exit fullscreen mode

To set all privileges on a database for a user, use the setAllPrivilegesOnDatabase() method:


$cpanel->setAllPrivilegesOnDatabase('Database username', 'Database Name');
Enter fullscreen mode Exit fullscreen mode

Mail Functions

To create a POP email account, use the createPopEmailAccount() method:


$cpanel->createPopEmailAccount('mail@domain.com', 'password');
Enter fullscreen mode Exit fullscreen mode

To delete a POP email account, use the deletePopEmailAccount() method:


$cpanel->deletePopEmailAccount('mail@domain.com');
Enter fullscreen mode Exit fullscreen mode

To edit the mailbox quota for an email account, use the editMailboxQuota() method:


$cpanel->editMailboxQuota($email, $domain, $quota);
Enter fullscreen mode Exit fullscreen mode

To dispatch client settings for an email account, use the dispatchClientSettings() method:


$cpanel->dispatchClientSettings('mail@domain.com', 'account');
Enter fullscreen mode Exit fullscreen mode

To get the POP email count, use the getPopEmailCount() method:


$cpanel->getPopEmailCount();
Enter fullscreen mode Exit fullscreen mode

cPanel Disk Management

To get cPanel statistics bar stats for bandwidth usage or disk usage, use the getCpanelStatsBarStats() method:


$cpanel->getCpanelStatsBarStats('bandwidthusage|diskusage');
Enter fullscreen mode Exit fullscreen mode

To get cPanel disk quota information, use the getCpanelDiskQuotaInfo() method:


$cpanel->getCpanelDiskQuotaInfo();
Enter fullscreen mode Exit fullscreen mode

Other API Functions

To call any other cPanel API function, use the callUAPI() method:


$cpanel->callUAPI($Module, $function, $parameters_array = array());
Enter fullscreen mode Exit fullscreen mode

Replace $Module with the desired module, $function with the function name, and $parameters_array with any additional parameters required by the API function.

That's it! You can now leverage the power of the Laravel CPanel API library to interact with the cPanel API seamlessly in your Laravel applications.

Top comments (0)