API Reference

hostcraftd serves one API over two transports: REST under /api/v1/ (through Caddy on port 2087) and gRPC on the Unix socket /run/hostcraft/hostcraftd.sock. The proto files under daemon/proto/hostcraft/v1/ are the contract. Every unary RPC names the REST route that implements it, and the daemon serves the gRPC call by running that same handler, so field names, validation, tenant scoping and errors are identical on both transports. Streaming RPCs (workflow and cluster events, archive upload, terminal) are implemented natively. See the Developer reference for authentication, error codes and examples.

Services

• Account: AccountService manages hosting accounts (the per-customer container for sites, mailboxes, databases and so on).
• AdminUser: AdminUserService manages super_admin and server_admin logins.
• Analytics: AnalyticsService reports GoAccess traffic analytics per site.
• App: AppService runs Node.js and Python applications as systemd units behind a site's reverse proxy.
• Audit: AuditService reads the audit log.
• Auth: AuthService exposes the parts of /api/v1/auth that make sense without a browser session.
• Backup: BackupService manages restic repositories, scheduled backup jobs, snapshots and restores.
• Cache: CacheService manages the per-site nginx FastCGI cache.
• Cluster: ClusterService manages a panel node's agents: nodes, enrolment tokens, decommission and drain, account moves, topology and the event feed.
• Cron: CronService manages per-account scheduled jobs (systemd timers).
• DB: DBService manages customer MariaDB/MySQL databases, users and grants.
• DNS: DNSService manages PowerDNS zones and records.
• Domain: DomainService manages the domains attached to accounts.
• Files: FilesService is the file manager.
• Firewall: FirewallService manages per-account nftables rules and country blocks.
• FTP: FTPService manages FTP(S) logins for accounts (Pure-FTPd, explicit TLS).
• Git: GitService manages Git repositories in account home directories and their deployments.
• IPAddress: IPAddressService manages the server IP pool (the WHM "IP Functions" set): adding and discovering addresses and assigning a dedicated IP to an account or site.
• License: LicenseService reports and changes the panel licence.
• Mail: MailService manages mailboxes, forwarders, autoresponders, Sieve filters, per-domain mail configuration, DKIM, the Postfix queue and Rspamd training.
• Notification: NotificationService is the in-panel notification centre and the admin alert channels.
• Plan: PlanService manages the hosting plan catalogue.
• Reseller: ResellerService manages reseller pools, their resource ceilings and their logins.
• Restore: RestoreService migrates cPanel full backups (cpmove archives) into HostCraft accounts: upload, probe, run, follow.
• Security: SecurityService fronts the security stack: WAF, CrowdSec, malware quarantine, FIM and the security policy.
• SSH: SSHService manages an account's SFTP access and authorized keys.
• SSL: SSLService issues, uploads, renews and installs TLS certificates.
• System: SystemService reports on and manages the host.
• Terminal: TerminalService opens interactive shells as an account's Unix user, the gRPC counterpart of the panel's web terminal (GET /ws/terminal).
• Transfer: TransferService drives the live WHM transfer tool: remote cPanel/WHM sources reached over SSH, batch queues that pkgacct and restore each account, and the final delta sync before cutover.
• Update: UpdateService checks for, installs and rolls back hostcraftd releases from updates.hostcraft.io.
• Web: WebService manages sites (an nginx vhost plus its PHP handler).
• Webhook: WebhookService manages outbound webhook endpoints, their deliveries and the local hook scripts run for the same events.
• Workflow: WorkflowService inspects workflow saga runs.
• WPToolkit: WPToolkitService manages WordPress installs: discovery, install, updates, staging, hardening, backups and vulnerability findings.