Download the PHP package beziworld/laravel-hestiacp without Composer
On this page you can find all versions of the php package beziworld/laravel-hestiacp. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download beziworld/laravel-hestiacp
More information about beziworld/laravel-hestiacp
Files in beziworld/laravel-hestiacp
Package laravel-hestiacp
Short Description Laravel client for the Hestia Control Panel API: users, web domains, DNS, mail, databases, cron, backups and Let's Encrypt.
License MIT
Homepage https://github.com/beziworld/laravel-hestiacp
Informations about the package laravel-hestiacp
Laravel HestiaCP
Laravel client for the Hestia Control Panel API: users and packages, web domains with aliases, redirects and FTP accounts, Let's Encrypt and SSL settings, DNS zones and records, mail domains, accounts, aliases, forwards, catch-all and DKIM, databases, cron jobs, backups and server information, for one or many servers.
Polska wersja dokumentacji
Features
- Access keys (
access_key+secret_key, orhash=ACCESS:SECRET) as recommended since Hestia 1.6, plus the deprecated API key and admin password methods for older servers - Exit code handling for both methods: with access keys the
Hestia-Exit-Codeheader, with the legacy methodsreturncode=yesfor changes and theError:prefix for reads, because those answer HTTP 200 for failed commands - Typed
CommandExceptionwith the exit code and its name (E_EXISTS,E_NOTEXIST,E_LIMIT, ...) and helpers such asalreadyExists()andnotFound() - Typed results (
User,WebDomain,DnsDomain,DnsRecord,MailDomain,MailAccount,Database,CronJob,Backup) built from the JSON output of thev-list-*commands, with dates in the server time zone - Read commands (
v-list-*,v-get-*,v-search-*) are repeated once after a connection error or HTTP 5xx; every other command is sent exactly once - Multiple named connections plus runtime connections with
HestiaCP::using([...]) query()andexecute()for any of the 400+v-*commands,php artisan hestiacp:check- PHP 8.3+, Laravel 12 and 13, PHPStan level 8
Why this package
The PHP clients on Packagist (gigabait/hestiacp-api, neto737/hestiacp-api, ponasromas/hestiacp-api and
forks) and the two Laravel packages (teaminfinitylk/laravel-hestiacp-sdk, 14 downloads, and
kitteam/hestia-api, 3 downloads, in November 2026) send commands but leave the different answers of the
authentication methods to you: with the deprecated methods a failed command is still HTTP 200. This package
follows the API source (web/api/index.php) and the official return code table, maps the keyed JSON output of the
list commands to data objects and adds Laravel configuration, Http::fake() support for your own tests and an
Artisan check.
Installation
Create the access key as the admin user in the panel or with v-add-access-key admin '*' laravel json on the
server, limit it to the commands you need when possible, and add the address of your application to the allowed
IP addresses of the API in the server settings.
Usage examples
Provision a hosting account after an order is paid
Users
Web domains, FTP and Let's Encrypt
DNS
Databases, cron and backups
Several servers
Anything else
Exceptions
All exceptions extend HestiaCPException:
| Exception | When |
|---|---|
AuthenticationException |
Credentials refused (exit code 9, E_PASSWORD, or HTTP 401 without an exit code). Never retried. Extends CommandException. |
CommandException |
A command failed or the API could not be reached: command(), exitCode(), errorName(), httpStatus(), output(), notFound(), alreadyExists(), forbidden(), limitReached() |
RateLimitException |
HTTP 429 from a proxy in front of the panel, retryAfter() in seconds |
InvalidConfiguration |
Unknown connection, missing URL / credentials or an invalid time zone |
Notes
- Commands run synchronously on the server and some (user creation, Let's Encrypt, backups) take several seconds: run them in queued jobs. The default timeout is 120 seconds.
- Hestia prefixes databases, database users and FTP accounts with the user name.
- Keys of non-admin users only work when the API is enabled for all users (
API_SYSTEM= 2) and only for their own objects.
Development
Author
Created and maintained by Kamil Ćwiertnia, beziworld.eu.
- E-mail: [email protected]
- Issues and feature requests: GitHub issues
- Security vulnerabilities: see SECURITY.md
Need an integration? Get in touch through beziworld.eu.
Other packages by the author
- beziworld/laravel-ispconfig: ISPConfig 3 remote API
- beziworld/laravel-mailcow: mailcow mail server
- beziworld/laravel-directadmin: DirectAdmin
License
MIT. See LICENSE.md. This package is not affiliated with the Hestia Control Panel project or its maintainers.
All versions of laravel-hestiacp with dependencies
ext-json Version *
guzzlehttp/guzzle Version ^7.8
illuminate/console Version ^12.0|^13.0
illuminate/contracts Version ^12.0|^13.0
illuminate/http Version ^12.0|^13.0
illuminate/support Version ^12.0|^13.0