PHPackages teaminfinitylk/laravel-hestiacp-sdk - 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. teaminfinitylk/laravel-hestiacp-sdk ActiveLibrary[API Development](/categories/api) teaminfinitylk/laravel-hestiacp-sdk =================================== A modern, Laravel SDK for the HestiaCP Control Panel API v1.0.0(1mo ago)10MITPHPPHP ^8.2CI passing Since Mar 28Pushed 1mo agoCompare [ Source](https://github.com/teaminfinitylk/laravel-hestiacp-sdk)[ Packagist](https://packagist.org/packages/teaminfinitylk/laravel-hestiacp-sdk)[ GitHub Sponsors](https://github.com/teaminfinitylk)[ RSS](/packages/teaminfinitylk-laravel-hestiacp-sdk/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)Dependencies (2)Versions (2)Used By (0) Laravel HestiaCP SDK ==================== [](#laravel-hestiacp-sdk) A modern, fully-typed Laravel SDK for the [HestiaCP](https://hestiacp.com) Control Panel API. [![PHP ^8.2](https://camo.githubusercontent.com/b5d4f7901c58ad1ddfff679966f426cc25a9354bab763846b9a7276c2feab4e0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253545382e322d626c7565)](https://www.php.net)[![License: MIT](https://camo.githubusercontent.com/5caa455d8debc46fb23abbadb45a733a937f3910a73fc875c2f7820468e1bb54/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d677265656e)](LICENSE)[![Laravel](https://github.com/teaminfinitylk/laravel-hestiacp-sdk/actions/workflows/tests.yml/badge.svg)](https://github.com/teaminfinitylk/laravel-hestiacp-sdk/actions/workflows/tests.yml) --- Installation ------------ [](#installation) ``` composer require teaminfinitylk/laravel-hestiacp-sdk ``` Configuration ------------- [](#configuration) Publish the config file: ``` php artisan vendor:publish --provider="TeamInfinityLK\HestiaCP\Laravel\HestiaServiceProvider" ``` Add to your `.env`: ``` HESTIA_URL=https://your-hestia-server:8083 # Option 1 — API Access Key (recommended) HESTIA_API_KEY=ACCESS_KEY_ID:SECRET_ACCESS_KEY # Option 2 — Username / Password HESTIA_USERNAME=admin HESTIA_PASSWORD=your-password # Optional HESTIA_TIMEOUT=30 HESTIA_VERIFY_SSL=true ``` > **Note:** HestiaCP's modern auth uses an access key pair in the format `ACCESS_KEY_ID:SECRET_ACCESS_KEY`. > Generate one from **Admin → Access Keys** in your HestiaCP panel. --- Quick Start ----------- [](#quick-start) ### Using the Facade [](#using-the-facade) ``` use Hestia; $users = Hestia::users()->list(); $domains = Hestia::web()->list('admin'); ``` ### Using Dependency Injection [](#using-dependency-injection) ``` use TeamInfinityLK\HestiaCP\HestiaClient; class HostingController extends Controller { public function __construct(private HestiaClient $hestia) {} public function index() { return $this->hestia->users()->list(); } } ``` ### Manual / Standalone Usage [](#manual--standalone-usage) ``` use TeamInfinityLK\HestiaCP\HestiaClient; // With API key $client = HestiaClient::connect('https://hestia.example.com:8083', 'KEYID:SECRET'); // With username + password $client = HestiaClient::connectWithCredentials('https://hestia.example.com:8083', 'admin', 'password'); ``` --- Resources --------- [](#resources) All resources are accessed via the client. Methods that operate on user data require `$username` as the first argument. ### Users — `users()` [](#users--users) ``` $hestia->users()->list(); // v-list-users $hestia->users()->get('john'); // v-list-user $hestia->users()->create([ 'user' => 'john', 'password' => 'secret', 'email' => 'john@example.com', 'package' => 'default', // optional 'name' => 'John', // optional 'lastname' => 'Doe', // optional ]); // v-add-user $hestia->users()->changePassword('john', 'newpass'); // v-change-user-password $hestia->users()->changeContact('john', 'email@example.com'); // v-change-user-contact $hestia->users()->changePackage('john', 'premium'); // v-change-user-package $hestia->users()->suspend('john'); // v-suspend-user $hestia->users()->unsuspend('john'); // v-unsuspend-user $hestia->users()->delete('john'); // v-delete-user ``` --- ### Web Domains — `web()` [](#web-domains--web) ``` $hestia->web()->list('john'); // v-list-web-domains $hestia->web()->get('john', 'example.com'); // v-list-web-domain $hestia->web()->create([ 'user' => 'john', 'domain' => 'example.com', 'ip' => '192.168.1.1', // optional (defaults to server primary IP) 'aliases' => 'www.example.com', // optional ]); // v-add-web-domain $hestia->web()->addSsl('john', 'example.com'); // v-add-letsencrypt-domain $hestia->web()->suspend('john', 'example.com'); // v-suspend-web-domain $hestia->web()->unsuspend('john', 'example.com'); // v-unsuspend-web-domain $hestia->web()->delete('john', 'example.com'); // v-delete-web-domain ``` --- ### Mail Domains & Accounts — `mail()` [](#mail-domains--accounts--mail) ``` // Domains $hestia->mail()->list('john'); // v-list-mail-domains $hestia->mail()->get('john', 'example.com'); // v-list-mail-domain $hestia->mail()->create([ 'user' => 'john', 'domain' => 'example.com', 'antispam' => 'yes', // optional, default: yes 'antivirus' => 'yes', // optional, default: yes 'dkim' => 'yes', // optional, default: yes 'ssl' => 'no', // optional ]); // v-add-mail-domain $hestia->mail()->suspend('john', 'example.com'); // v-suspend-mail-domain $hestia->mail()->unsuspend('john', 'example.com'); // v-unsuspend-mail-domain $hestia->mail()->delete('john', 'example.com'); // v-delete-mail-domain // Accounts $hestia->mail()->listAccounts('john', 'example.com'); // v-list-mail-accounts $hestia->mail()->addAccount([ 'user' => 'john', 'domain' => 'example.com', 'account' => 'info', 'password' => 'secret', 'quota' => '0', // optional, 0 = unlimited ]); // v-add-mail-account $hestia->mail()->changeAccountPassword('john', 'example.com', 'info', 'newpass'); $hestia->mail()->deleteAccount('john', 'example.com', 'info'); // v-delete-mail-account ``` --- ### Databases — `databases()` [](#databases--databases) > HestiaCP automatically prefixes database and DB user names with the owner's username. > e.g. user `john` + database `blog` → stored as `john_blog`. ``` $hestia->databases()->list('john'); // v-list-databases $hestia->databases()->get('john', 'john_blog'); // v-list-database $hestia->databases()->create([ 'user' => 'john', 'database' => 'blog', // stored as john_blog 'dbuser' => 'bloguser', // stored as john_bloguser 'dbpass' => 'secret', 'type' => 'mysql', // optional, default: mysql 'charset' => 'utf8mb4', // optional ]); // v-add-database $hestia->databases()->changePassword('john', 'john_blog', 'john_bloguser', 'newpass'); $hestia->databases()->suspend('john', 'john_blog'); // v-suspend-database $hestia->databases()->unsuspend('john', 'john_blog'); // v-unsuspend-database $hestia->databases()->delete('john', 'john_blog'); // v-delete-database ``` --- ### DNS — `dns()` [](#dns--dns) ``` // Zones $hestia->dns()->list('john'); // v-list-dns-domains $hestia->dns()->get('john', 'example.com'); // v-list-dns-domain $hestia->dns()->create([ 'user' => 'john', 'domain' => 'example.com', 'ip' => '192.168.1.1', // optional ]); // v-add-dns-domain $hestia->dns()->suspend('john', 'example.com'); $hestia->dns()->unsuspend('john', 'example.com'); $hestia->dns()->delete('john', 'example.com'); // v-delete-dns-domain // Records $hestia->dns()->listRecords('john', 'example.com'); // v-list-dns-records $hestia->dns()->addRecord('john', 'example.com', [ 'record' => 'mail', 'type' => 'A', 'value' => '192.168.1.2', 'priority' => '0', // optional 'ttl' => '14400', // optional ]); // v-add-dns-record $hestia->dns()->updateRecord('john', 'example.com', 5, [...]); $hestia->dns()->deleteRecord('john', 'example.com', 5); // v-delete-dns-record ``` --- ### Cron Jobs — `cron()` [](#cron-jobs--cron) ``` $hestia->cron()->list('john'); // v-list-cron-jobs $hestia->cron()->get('john', 1); // v-list-cron-job (by numeric job ID) $hestia->cron()->create([ 'user' => 'john', 'min' => '0', 'hour' => '2', 'day' => '*', 'month' => '*', 'wday' => '*', 'command' => '/home/john/scripts/backup.sh', ]); // v-add-cron-job $hestia->cron()->suspend('john', 1); // v-suspend-cron-job $hestia->cron()->unsuspend('john', 1); // v-unsuspend-cron-job $hestia->cron()->delete('john', 1); // v-delete-cron-job ``` --- ### Backups — `backups()` [](#backups--backups) ``` $hestia->backups()->list('john'); // v-list-user-backups $hestia->backups()->get('john', '2024-01-01_00-00-00.tar'); $hestia->backups()->create('john'); // v-backup-user (triggers backup now) $hestia->backups()->restore('john', '2024-01-01_00-00-00.tar', [ 'web' => 'yes', // optional, default all yes 'mail' => 'yes', 'db' => 'yes', 'dns' => 'yes', ]); // v-restore-user $hestia->backups()->delete('john', '2024-01-01_00-00-00.tar'); ``` --- ### Firewall — `firewall()` [](#firewall--firewall) ``` $hestia->firewall()->list(); // v-list-firewall $hestia->firewall()->get(1); // v-list-firewall-rule $hestia->firewall()->create([ 'action' => 'ACCEPT', // ACCEPT | DROP | REJECT 'ip' => '0.0.0.0/0', 'port' => '80', 'protocol' => 'TCP', // optional 'comment' => 'Allow HTTP', // optional ]); // v-add-firewall-rule $hestia->firewall()->delete(1); // v-delete-firewall-rule // Bans (fail2ban) $hestia->firewall()->listBans('CUSTOM'); // v-list-firewall-ban $hestia->firewall()->banIp('1.2.3.4', 'CUSTOM'); // v-add-firewall-ban $hestia->firewall()->unbanIp('1.2.3.4', 'CUSTOM');// v-delete-firewall-ban ``` --- ### IP Addresses — `ips()` [](#ip-addresses--ips) > System-level IPs. Requires admin privileges. ``` $hestia->ips()->list(); // v-list-sys-ips $hestia->ips()->get('192.168.1.100'); // v-list-sys-ip $hestia->ips()->create([ 'ip' => '192.168.1.100', 'netmask' => '255.255.255.0', 'interface' => 'eth0', 'user' => 'admin', // optional 'status' => 'shared', // optional ]); // v-add-sys-ip $hestia->ips()->changeOwner('192.168.1.100', 'john'); $hestia->ips()->changeName('192.168.1.100', 'My IP'); $hestia->ips()->delete('192.168.1.100'); // v-delete-sys-ip ``` --- ### Packages — `packages()` [](#packages--packages) ``` $hestia->packages()->list(); // v-list-user-packages $hestia->packages()->get('default'); // v-list-user-package $hestia->packages()->delete('old-package'); // v-delete-user-package ``` --- DTOs ---- [](#dtos) Typed Data Transfer Objects are returned by `list()` calls: DTOReturned by`UserDto``users()->list()``WebDomainDto``web()->list()``MailDomainDto``mail()->list()``DatabaseDto``databases()->list()``DnsRecordDto``dns()->listRecords()`--- Exception Handling ------------------ [](#exception-handling) ``` use TeamInfinityLK\HestiaCP\Exceptions\ApiException; use TeamInfinityLK\HestiaCP\Exceptions\AuthenticationException; use TeamInfinityLK\HestiaCP\Exceptions\ConnectionException; try { $users = Hestia::users()->list(); } catch (AuthenticationException $e) { // Invalid API key / credentials } catch (ConnectionException $e) { // Cannot reach the HestiaCP server } catch (ApiException $e) { // HestiaCP returned an error code echo $e->getMessage(); // "Failed to list users: E_FORBIDDEN" echo $e->getCode(); // HestiaCP return code (1–20) } ``` ### HestiaCP Return Codes [](#hestiacp-return-codes) CodeNameMeaning0OKSuccess1E\_ARGSMissing or invalid arguments2E\_INVALIDInvalid object value3E\_NOTEXISTObject does not exist4E\_EXISTSObject already exists5E\_SUSPENDEDObject is suspended6E\_UNSUSPENDEDObject is not suspended7E\_INUSEObject is in use8E\_LIMITResource limit reached9E\_PASSWORDInvalid password10E\_FORBIDDENCommand not permitted11E\_DISABLEDFeature disabled15E\_CONNECTConnection error17E\_DBDatabase error--- Billing Automation Example -------------------------- [](#billing-automation-example) A common billing integration pattern — create a full hosting account: ``` // 1. Create the user account $hestia->users()->create([ 'user' => 'john', 'password' => 'generated-password', 'email' => 'john@example.com', 'package' => 'starter', 'name' => 'John', 'lastname' => 'Doe', ]); // 2. Add their web domain $hestia->web()->create([ 'user' => 'john', 'domain' => 'johnssite.com', ]); // 3. Enable Let's Encrypt SSL $hestia->web()->addSsl('john', 'johnssite.com'); // 4. Set up mail $hestia->mail()->create([ 'user' => 'john', 'domain' => 'johnssite.com', ]); $hestia->mail()->addAccount([ 'user' => 'john', 'domain' => 'johnssite.com', 'account' => 'info', 'password' => 'mail-password', ]); // 5. Create database $hestia->databases()->create([ 'user' => 'john', 'database' => 'maindb', 'dbuser' => 'mainuser', 'dbpass' => 'db-password', ]); // Suspend account on non-payment $hestia->users()->suspend('john'); // Reactivate $hestia->users()->unsuspend('john'); // Terminate $hestia->users()->delete('john'); ``` --- Testing ------- [](#testing) ``` ./vendor/bin/pest ``` --- Requirements ------------ [](#requirements) - PHP ^8.2 - cURL extension enabled - HestiaCP server (any recent version) --- License ------- [](#license) MIT © [TeamInfinity PVT LTD](https://teaminfinity.lk) ### Health Score 38 — LowBetter than 85% of packages Maintenance90 Actively maintained with recent releases Popularity2 Limited adoption so far Community8 Small or concentrated contributor base Maturity46 Maturing project, gaining track record Bus Factor1 Top contributor holds 87.5% 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 Unknown Total 1 Last Release 45d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/1a3cc9dd67c18b24d3e1be0af4b01945b9bc7687ae1467225e3ecaf7836a6253?d=identicon)[ChamikaSamaraweera](/maintainers/ChamikaSamaraweera) --- Top Contributors [![DCComplex](https://avatars.githubusercontent.com/u/161657580?v=4)](https://github.com/DCComplex "DCComplex (7 commits)")[![ChamikaSamaraweera](https://avatars.githubusercontent.com/u/163977973?v=4)](https://github.com/ChamikaSamaraweera "ChamikaSamaraweera (1 commits)") --- Tags apisdkhostinghestiacpteaminfinitylk ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/teaminfinitylk-laravel-hestiacp-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/teaminfinitylk-laravel-hestiacp-sdk/health.svg)](https://phpackages.com/packages/teaminfinitylk-laravel-hestiacp-sdk) ``` ### Alternatives [deepseek-php/deepseek-php-client deepseek PHP client is a robust and community-driven PHP client library for seamless integration with the Deepseek API, offering efficient access to advanced AI and data processing capabilities. 47073.9k5](/packages/deepseek-php-deepseek-php-client)[jstolpe/instagram-graph-api-php-sdk Instagram Graph API PHP SDK 13998.4k2](/packages/jstolpe-instagram-graph-api-php-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)