PHPackages                             akhaled/cpanel-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. akhaled/cpanel-api

ActiveLibrary[API Development](/categories/api)

akhaled/cpanel-api
==================

Unofficial api for cpanel

v1.1.5(3y ago)11338PHP

Since Feb 2Pushed 2y ago2 watchersCompare

[ Source](https://github.com/akhled/cpanel-api)[ Packagist](https://packagist.org/packages/akhaled/cpanel-api)[ RSS](/packages/akhaled-cpanel-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (7)Dependencies (4)Versions (8)Used By (0)

CPANEL API
===========

[](#cpanel-api-)

Unofficial CPanel wrapper for shared hosting. For Laravel.

- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
    - [Domains](#domains)
        - [Create domain](#create-domain)
        - [Delete domain](#delete-domain)
    - [Addon domains](#addon-domains)
        - [Create addon domain](#create-addon-domain)
        - [Delete addon domain](#delete-addon-domain)
    - [Subdomain](#subdomain)
        - [Create subdomain](#create-subdomain)
        - [Delete subdomain](#delete-subdomain)
    - [Database](#database)
        - [Create database](#create-database)
        - [Delete database](#delete-database)
    - [Database User](#database-user)
        - [Create database user](#create-database-user)
        - [Add user to database](#add-user-to-database)
        - [Delete database user](#delete-database-user)

Installation
------------

[](#installation)

`composer require akhaled/cpanel-api`

Configuration
-------------

[](#configuration)

Add following configuration to `.env` file

```
CPANEL_USER=xxxxxx
CPANEL_PASSWORD=xxxxx
CPANEL_HOST=123.456.789
CPANEL_SKIN=paper_lantern
CPANEL_DEFAULT_DOMAIN_DIR=public_html
CPANEL_TOKEN=xxxxx
CPANEL_DOMAIN=example.com
```

Usage
-----

[](#usage)

### Domains

[](#domains)

#### Create domain

[](#create-domain)

```
$domain = 'example.com';

Akhaled\CPanelAPI\Facades\CPanelAPI::domain()->create($domain);
```

#### Delete domain

[](#delete-domain)

```
$domain = 'example.com';

Akhaled\CPanelAPI\Facades\CPanelAPI::domain()->delete($domain);
```

### Addon domains

[](#addon-domains)

#### Create addon domain

[](#create-addon-domain)

```
$domain = 'example.com';
$subdomain = 'example';
$dir = 'public_html'; // optional, default config('cpanel.default_dir')

Akhaled\CPanelAPI\Facades\CPanelAPI::addonDomain()->create($domain, $subdomain, $dir);
```

#### Delete addon domain

[](#delete-addon-domain)

```
$domain = 'example.com';
$subdomain = 'example_base.com';

Akhaled\CPanelAPI\Facades\CPanelAPI::addonDomain()->delete($domain, $subdomain);
```

### Subdomain

[](#subdomain)

#### Create subdomain

[](#create-subdomain)

```
// subdomain: beta.example.com
$domain = 'example.com';
$subdomain = 'beta';
$dir = 'public_html'; // optional, default config('cpanel.default_dir')

Akhaled\CPanelAPI\Facades\CPanelAPI::subdomain($domain)->create($subdomain, $dir);
```

#### Delete subdomain

[](#delete-subdomain)

```
// subdomain: beta.example.com
$domain = 'example.com';
$subdomain = 'beta';

Akhaled\CPanelAPI\Facades\CPanelAPI::subdomain($domain)->delete($subdomain);
```

### Database

[](#database)

#### Create database

[](#create-database)

```
$db_name = 'fresh_database';

Akhaled\CPanelAPI\Facades\CPanelAPI::database()->create($db_name);
```

#### Delete database

[](#delete-database)

```
$db_name = 'my_old_database';

Akhaled\CPanelAPI\Facades\CPanelAPI::database()->delete($db_name);
```

### Database User

[](#database-user)

#### Create database user

[](#create-database-user)

```
$db_user = 'my_old_user_name';
$db_password = 'raw_password';

Akhaled\CPanelAPI\Facades\CPanelAPI::databaseUser()->create($db_user, $db_password);
```

#### Add user to database

[](#add-user-to-database)

```
$db_user = 'user_name';
$db_name = 'database';

Akhaled\CPanelAPI\Facades\CPanelAPI::databaseUser()->addToDatabase($db_user, $db_name);
```

#### Delete database user

[](#delete-database-user)

```
    $db_user = 'my_old_user_name';

    Akhaled\CPanelAPI\Facades\CPanelAPI::databaseUser()->delete($db_user);
```

License
-------

[](#license)

CPanel package is open-sourced software licensed under the [MIT license](LICENSE.md).

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~40 days

Recently: every ~1 days

Total

7

Last Release

1316d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b287abe0508bd1591fc87a4d0b770a9545fe6033e9be97f1fcab4d5ec78753c6?d=identicon)[akhaled](/maintainers/akhaled)

---

Top Contributors

[![amrography](https://avatars.githubusercontent.com/u/9614340?v=4)](https://github.com/amrography "amrography (26 commits)")

### Embed Badge

![Health badge](/badges/akhaled-cpanel-api/health.svg)

```
[![Health](https://phpackages.com/badges/akhaled-cpanel-api/health.svg)](https://phpackages.com/packages/akhaled-cpanel-api)
```

###  Alternatives

[mollie/laravel-mollie

Mollie API client wrapper for Laravel & Mollie Connect provider for Laravel Socialite

3624.1M28](/packages/mollie-laravel-mollie)[mll-lab/laravel-graphiql

Easily integrate GraphiQL into your Laravel project

683.2M9](/packages/mll-lab-laravel-graphiql)[esign/laravel-conversions-api

A laravel wrapper package around the Facebook Conversions API

69145.4k](/packages/esign-laravel-conversions-api)[didww/didww-api-3-php-sdk

PHP SDK for DIDWW API 3

1218.2k](/packages/didww-didww-api-3-php-sdk)[surface/laravel-webfinger

A Laravel package to create an ActivityPub webfinger.

113.8k](/packages/surface-laravel-webfinger)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)