gigabait/hestiacp-api

HestiaCP API SDK in PHP

dev-main 2023-10-14 18:27 UTC

Requires

• php: >=8.1
• guzzlehttp/guzzle: ^7
• nette/utils: ^4

MIT

• GIGABAIT

README

How to use

1. Installation

$ composer require gigabait/hestiacp-api:dev-main

1. Create Client

Use API key, username and password is possible but highly discouraged as deemed unsafe and will be deprecated.

use HestiaCP\Client;
use HestiaCP\Authorization\Credentials;
use HestiaCP\Authorization\Host;

// You can choose to use an API Key or username and password (legacy)
$credentials = new Credentials('Key:Secret');
$port = 8083;
$host = new Host('https://server', $credentials, $port);
$client = new Client($host);

1. Usage

You can simply send one of prepared commands (or you can write your own command, just be sure to implement HestiaCP\Command\ICommand )

$command = new SomeCommand();

$response = $client->send($command);

echo $response->getResponseText();

List of prepared modules:

User

$userModule = $client->getModuleUser();

$userModule->list(); // returns all users with data

$userModule->detail('admin'); // returns selected user with data

$userModule->changePassword('admin', 'otherPa$$word');

$userModule->add('other_user', 'pa$$word', '[e-mail]');

$userModule->suspend('other_user');

$userModule->unsuspend('other_user');

$userModule->delete('other_user');

Web

$webModule = $client->getModuleWeb('admin'); // web module needs user

$webModule->listDomains();

$webModule->addDomain('domain.com');

$webModule->addDomainLetsEncrypt('domain.com', 'www.domain.com'); // needs longer timeout

$webModule->deleteDomainLetsEncrypt('domain.com');

$webModule->addDomainFtp('domain.com', 'test', 'pa$$word');

$webModule->changeDomainFtpPassword('domain.com', 'admin_test', 'otherPa$$word');

$webModule->changeDomainFtpPath('domain.com', 'admin_test', 'path/other');

$webModule->deleteDomainFtp('domain.com', 'admin_test');

$webModule->suspendDomain('domain.com');

$webModule->unsuspendDomain('domain.com');

$webModule->deleteDomain('domain.com');

Mail

$mailModule = $client->getModuleMail('admin'); // mail module needs user

$mailModule->listDomains(); // returns mail domains from selected user

$mailModule->addDomain('domain.com'); // add domain

$mailModule->listAccounts('domain.com'); // returns accounts from selected user and domain

$mailModule->listDomainDkim('domain.com');

$mailModule->listDomainDkimDns('domain.com');

$mailModule->addAccount('domain.com', 'info', 'pa$$word'); // add [e-mail] account

$mailModule->changeAccountPassword('domain.com', 'info', 'otherPa$$word'); // change [e-mail] password

$mailModule->suspendAccount('domain.com', 'info'); // suspend [e-mail] account

$mailModule->unsuspendAccount('domain.com', 'info'); // unsuspend [e-mail] account

$mailModule->deleteAccount('domain.com', 'info');

$mailModule->suspendDomain('domain.com');

$mailModule->unsuspendDomain('domain.com');

$mailModule->deleteDomain('domain.com');

DB

$dbModule = $client->getModuleDatabase('admin');

$dbModule->add('database', 'dbuser', 'dbpass');

$dbModule->delete('admin_database');

$dbModule->deleteDatabases();

$dbModule->listDatabase('database');

$dbModule->listDatabases();

Backups

$backupModule = $client->getModuleBackup('admin'); // backup module needs user

$backupModule->backup(); // create a new backup

$backupModule->delete('admin.2021-10-13_18-12-53.tar'); // delete an user backup

$backupModule->deleteExclusions(); // delete all backup exclusions

$backupModule->listBackups(); // returns the backups list

$backupModule->listBackup('admin.2021-10-13_18-12-53.tar'); // returns backup parameters list

$backupModule->listBackupExclusions(); // returns the backup exclusions list

DNS

$dnsModule = $client->getModuleDNS();