Download the PHP package neto737/hestiacp-api without Composer
On this page you can find all versions of the php package neto737/hestiacp-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download neto737/hestiacp-api
More information about neto737/hestiacp-api
Files in neto737/hestiacp-api
Package hestiacp-api
Short Description PHP client for the HestiaCP API: users, web domains, mail, DNS, databases, backups, cron jobs and packages
License MIT
Homepage https://github.com/neto737/HestiaCP-API
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package hestiacp-api
HestiaCP PHP API
A modern PHP client for the HestiaCP API.
Manage users, web domains, mail, databases and backups on a HestiaCP server from your PHP code.
Features
- Every HestiaCP login method: access keys (HestiaCP 1.6+), legacy API keys, and admin username and password.
- Ready-made modules for users, web domains, mail, DNS, databases, backups, cron jobs and packages.
- Errors as exceptions: each failure is a typed exception that carries HestiaCP's exit code, so you can tell "already exists" apart from "bad credentials".
- TLS verification on by default, with an option for self-signed certificates.
- Plain PHP arrays as results. The only dependency is Guzzle.
- Lower-level access: send any of the bundled command classes directly, run any
v-*script by name withRawCommandandRawListCommand, or write your own. - Tested on PHP 8.2 to 8.5 and checked against HestiaCP 1.10.
Requirements
- PHP 8.2 or later
- HestiaCP with the API enabled, and the IP address of the calling machine allowed in the server settings
Installation
Quick start
[!NOTE] TLS certificates are verified by default. If your panel still uses the self-signed certificate created at install, see TLS certificates.
Modules
| Module | Get it with | What it covers |
|---|---|---|
| Users | getModuleUser() |
List, show, add and delete users. Change passwords, contact emails and packages, suspend and unsuspend, list usage stats, back up all users. |
| Web domains | getModuleWeb($user) |
Add, delete, suspend and unsuspend domains. Aliases, SSL certificates, Let's Encrypt, templates, proxy and FTP accounts. |
getModuleMail($user) |
Mail domains and accounts, passwords, suspending, aliases, forwarding, autoreplies, DKIM keys and DNS records. | |
| Databases | getModuleDatabase($user) |
Create, list and delete databases. Change passwords, suspend and unsuspend. |
| Backups | getModuleBackup($user) |
Create, list and delete backups. List and delete backup exclusions. |
| Packages | getModulePackage() |
List and show hosting packages. |
| Cron jobs | getModuleCron($user) |
List, add, change, suspend, unsuspend and delete cron jobs. |
| DNS | getModuleDns($user) |
DNS domains and records: add, change, suspend, unsuspend and delete. TTL, SOA, templates and DNSSEC. |
Need a command that isn't wrapped in a module? See run any script by name when no command class exists for it.
Error handling
All exception types and exit codes are listed in Error handling.
Documentation
- Authentication and client setup: access keys, legacy API keys, passwords, hostname rules, TLS and timeouts
- Error handling: exception types and HestiaCP exit codes
- Modules: Backups
- Sending commands directly: using the command classes, and writing your own
Upgrading from v1? Read CHANGELOG.md.
Contributing
Bug reports and pull requests are welcome. To run the checks:
Each check can also run on its own: composer test (PHPUnit), composer analyse (PHPStan) and composer cs (PHP-CS-Fixer). composer cs-fix fixes the coding style. The code uses tabs for indentation and LF line endings.
The tests use Guzzle's mock handler, so they don't need a HestiaCP server.
Credits
This library started as a fork of ProfiCloS/vestacp-api by PROFI CLOUD SERVICES s.r.o., a client for VestaCP, and was adapted and extended for HestiaCP.
This is a community project. It is not affiliated with or endorsed by the HestiaCP project. The Hestia logo used in this project's logo is copyright hestiacp.com and is included unmodified.
Support the project :heart:
If this library saves you time, you can support its development via Liberapay, PayPal or crypto:
License
Released under the MIT License.
All versions of hestiacp-api with dependencies
guzzlehttp/guzzle Version ^7.15.2 || ^8.2
psr/http-message Version ^1.1 || ^2.0