Download the PHP package chuckbartowski/cpanel-sdk without Composer

Framework-agnostic core — usable from any PHP project, script, or worker — with an optional bundle for first-class Symfony integration. Authenticated with API tokens, typed exceptions, and a comment-free, strictly typed codebase (PHP 8.2+, declare(strict_types=1) everywhere).

Table of Contents

• Features
• Requirements
• Installation
• Quick Start (plain PHP)
• Symfony Integration (optional)
• Architecture
• Usage
  • The Cpanel facade
  • The Whm facade
  • Generic calls (escape hatch)
• API Reference
  • Email
  • Domains
  • MySQL
  • FTP
  • SSL
  • Files
  • DNS (cPanel zone editor)
  • Stats & quotas
  • WHM — Accounts
  • WHM — Resellers
  • WHM — Packages
  • WHM — DNS zones
  • WHM — IP addresses
  • WHM — Security (cPHulk)
  • WHM — Backups & restores
  • WHM — PHP versions
  • WHM — SSL & AutoSSL
  • WHM — Server configuration
  • WHM — Server
• Responses
• Error Handling
• Testing
• Security Notes
• WHMCS module
• License

Features

• Full coverage of the three cPanel API surfaces: UAPI (the modern cPanel API), API2 (legacy but still required for zone editing, subdomains, addon domains, file operations), and WHM API 1 (server administration).
• Framework-agnostic: two plain facades (Cpanel, Whm) you can instantiate anywhere; only hard dependency is symfony/http-client, a standalone component that works in any PHP project.
• Token authentication only — no passwords, no sessions, no cookies. Uses the official Authorization: cpanel user:token / Authorization: whm user:token schemes.
• High-level, discoverable modules grouped by domain: email, MySQL, DNS, SSL, files, accounts, resellers, backups, PHP versions, security…
• A single normalized response object (ApiResponse) regardless of which underlying API answered — you never parse cpanelresult or metadata envelopes yourself.
• Typed exception hierarchy under one marker interface, so you can catch narrowly or broadly.
• Escape hatches everywhere: any endpoint not wrapped by a module remains one method call away.
• Optional Symfony bundle with semantic configuration and autowirable services.
• Fully unit-tested against MockHttpClient (no network required).

Requirements

You will need at least one of:

• a cPanel API token — created in cPanel » Security » Manage API Tokens
• a WHM API token — created in WHM » Development » Manage API Tokens

Installation

The package is published on Packagist:

Quick Start (plain PHP)

No framework required — build the clients and go:

Client constructor signature (identical for both clients):

Symfony Integration (optional)

A ready-made bundle wires everything into the container. Register it:

Then create config/packages/cpanel_sdk.yaml:

And the matching environment variables:

Configuration reference

The cpanel and whm sections are independent — configure only the side you need. Calling a client with missing credentials throws an AuthenticationException immediately, before any network request is made.

The bundle reuses your application's http_client service when available (so scoped clients, retry strategies, and profiler integration all apply), and falls back to a native client otherwise.

Architecture

Design decisions:

• Facade + lazy modules: Cpanel/Whm instantiate each module on first use and cache it, so the DI container only carries four services.
• Modules always validate: every module method calls ensureSuccess() internally and throws ApiException on failure. If you need to inspect a failed response without an exception, drop down to the client level.
• Nothing is sealed off: the clients' generic methods accept any module/function/parameter combination, so a cPanel endpoint added tomorrow is usable today.

Usage

Standalone, instantiate the facades as shown in the Quick Start. In Symfony, both facades are autowirable in controllers, services, commands, and message handlers.

The Cpanel facade

The Whm facade

Generic calls (escape hatch)

Any endpoint not covered by a module remains reachable:

cpanelUapi() runs a UAPI function as any cPanel account through the WHM token — the standard pattern for hosting control panels where only the root/reseller token is stored.

API Reference

Every method returns an Error Handling). Named arguments are shown where they improve readability.

Email

$cpanel->email() — UAPI Email module.

Domains

$cpanel->domains() — UAPI DomainInfo + API2 SubDomain / AddonDomain / Park.

MySQL

$cpanel->mysql() — UAPI Mysql module.

Remember that cPanel prefixes database and user names with the account name (myaccount_app).

FTP

$cpanel->ftp() — UAPI Ftp module: accounts(), create(), delete() (with optional home-dir destruction), changePassword(), setQuota(), setHomeDir().

SSL

$cpanel->ssl() — UAPI SSL module: certificates(), installedHosts(), install(), delete(), generateKey(), generateCsr().

Files

$cpanel->files() — UAPI Fileman for content, API2 Fileman::fileop for filesystem operations: list(), read(), write(), info(), mkdir(), delete(), copy(), move(), chmod(), extract(), emptyTrash().

DNS (cPanel zone editor)

$cpanel->dns() — API2 ZoneEdit module. addRecord() automatically maps the value to the right parameter name for the record type (address for A/AAAA, cname for CNAME, txtdata for TXT, exchange for MX…).

API2 zone records are addressed by line number in the zone file; always re-fetch records after a mutation before addressing another line.

Stats & quotas

$cpanel->stats() — quota() (UAPI Quota), bars() (UAPI StatsBar, configurable display list), bandwidth() (API2 Stats::getmonthlybandwidth).

WHM — Accounts

$whm->accounts() — the account lifecycle, WHM API 1.

WHM — Resellers

$whm->resellers() — the full reseller lifecycle for multi-tier hosting.

WHM — Packages

$whm->packages() — list(), create(), update(), delete() around listpkgs / addpkg / editpkg / killpkg.

WHM — DNS zones

$whm->dnsZones() — full zone lifecycle: list(), dump(), create(), delete(), addRecord(), editRecord(), removeRecord(), reset().

WHM — IP addresses

$whm->ips() — IP pool management for dedicated-IP offers.

WHM — Security (cPHulk)

$whm->security() — brute-force protection management, the bread and butter of hosting support.

WHM — Backups & restores

$whm->backups() — backup configuration and the account restore queue.

WHM — PHP versions

$whm->php() — MultiPHP management per virtual host.

Versions use EasyApache identifiers (ea-php83), not bare numbers.

WHM — SSL & AutoSSL

$whm->autoSsl() — server-wide certificate automation plus manual installs with root privileges.

WHM — Server configuration

$whm->config() — Tweak Settings and global server preferences.

WHM — Server

$whm->server() — version(), hostname(), loadAverage(), serviceStatus(), restartService().

Responses

All calls return an immutable ApiResponse that normalizes the three wire formats (UAPI envelope, API2 cpanelresult, WHM metadata):

data() is null-safe: it returns the default when the payload has no such key or when data is not an array.

Error Handling

All SDK exceptions implement CpanelSdkExceptionInterface, so a single catch covers everything:

To inspect a failed response without exceptions, use the client directly — client-level methods return the response as-is:

Testing

The suite runs entirely offline against MockHttpClient:

To test your own services, inject a CpanelClient/WhmClient built with a mock:

Security Notes

• API tokens are passed with #[\SensitiveParameter], so they never appear in stack traces.
• Keep tokens in .env.local or your secret vault — never commit them.
• Scope WHM tokens to the minimal privilege set in WHM » Manage API Tokens (e.g. deny Everything, allow only account functions).
• Leave verify_ssl: true in production; the option exists solely for self-signed development servers.
• removeacct and delete_ftp destroy=1 are irreversible — gate them behind confirmation flows in your application.

WHMCS module

A ready-to-use WHMCS provisioning module ships in whmcs/modules/servers/cpanelsdk/. It automates cPanel account provisioning through WHM using this SDK — create, suspend, unsuspend, terminate, change password, change package, and one-click SSO into cPanel.

Install

1. composer require chuckbartowski/cpanel-sdk in your WHMCS root (so the SDK is autoloaded).
2. Copy the cpanelsdk folder into <whmcs>/modules/servers/.
3. In WHMCS, add a server (System Settings » Servers) with Type: cPanel (SDK), the WHM hostname, username root, and your WHM API token in the Access Hash field.
4. Point a product at the server and set the Package config option to the WHM plan name.

License

MIT