Module and release scope
This guide covers cPanel / WHM 1.4.0, Extension API 1, from the reviewed product source. Its declared core range is 1.3.6–1.3.99. Use the matching released core and signed provider package; a version label alone does not install the required contracts. Source availability does not mean the module is bundled in every currently downloadable product, installed on your server, enabled or certified for your merchant/server account. Nothing in this guide enables a provider or changes your existing connections.
Open System → Hosting servers (newer source may group these as Payments, Domain services or Hosting services). Install the reviewed signed package through Modules & addons or the integration workspace's Install tab, enable the module separately, add an account/connection, save its own credentials, run its stated Test and explicitly enable the connection. Saving or retesting disables the connection until you enable it again. Start with the provider's test environment where supported; otherwise use an isolated account or server.
Exact connection fields
These are the fields declared by this module. Secret values are entered privately and encrypted by the application. Defaults are configuration hints, not approved live merchant settings. Internal fields are populated by the module and are not operator-editable.
| Key / label | Type | Required | Default / guidance |
|---|---|---|---|
server_url — WHM HTTPS address |
url | Yes | Use the exact server origin, normally https://hostname:2087. |
username — WHM administrator or reseller |
text | Yes | Use the account-specific value described below. |
api_token — WHM API token |
secret | Yes | Use the account-specific value described below. |
default_nameservers — Assigned server nameservers |
text | No | Two or more nameservers separated by commas or spaces. |
allow_writes — Allow account creation and changes |
boolean | No | Default: false |
allow_reseller — Allow reseller account creation |
boolean | No | Default: false |
allow_sso — Allow temporary customer sign-in |
boolean | No | Default: false |
allow_autossl — Allow AutoSSL requests |
boolean | No | Default: false |
API 1 server module for the matching EmailaBiller hosting core. Fresh installations are disabled and contain no server account, token, nameserver or business data. Existing installed cPanel versions and active server connections are not replaced automatically.
Configure
Use the exact WHM HTTPS origin, normally https://server.example.test:2087, a WHM administrator/reseller username and its API token. Use a valid trusted TLS certificate. Allow API access through the hosting firewall. The account must have the permissions for the operations you intend to use, including version, listpkgs, listaccts, accountsummary, createacct, suspendacct, unsuspendacct and changepackage. Reseller creation additionally requires the appropriate reseller privileges. Limit the token to the required permissions and server/source IPs.
Test performs the authenticated read-only version call. Configure the server's default nameservers explicitly, run Test, enable the connection explicitly and validate its creatable package inventory. Map each product to an exact package and automatic fulfilment mode. Account writes, reseller creation, temporary customer sign-in and AutoSSL start disabled.
Operations
Uses the core's existing guarded cPanel provisioning, account reconciliation, credential vault and customer-access implementation. Supports creation, synchronization, suspension, restoration, package changes, temporary sign-in and explicitly permitted AutoSSL requests. Automated termination follows the existing enabled lifecycle policy and only deletes a remotely confirmed suspended account. API acceptance does not promise that a certificate has been issued or DNS is already propagated.
Creation reserves a stable login, validates the exact package, checks both domain and username for existing accounts and stores a generated password encrypted. A paid invoice and uncancelled owning customer/service binding are required. A fresh exact account read confirms username, primary domain, package and suspension state. An uncertain creation request must be reconciled; it is never automatically repeated. Remote shared accounts do not prove VPS or dedicated-server delivery.
Provider documentation
- WHM API 1: https://api.docs.cpanel.net/whm/introduction/
- Create account: https://api.docs.cpanel.net/openapi/whm/operation/createacct/
- Account summary: https://api.docs.cpanel.net/openapi/whm/operation/accountsummary/
- Creatable packages: https://api.docs.cpanel.net/openapi/whm/operation/listpkgs/
- API tokens: https://docs.cpanel.net/whm/development/manage-api-tokens-in-whm/
Install this source's matching core update before enabling it. A newly built package does not upgrade or disable an existing production cPanel connection; upgrades require a separate operator action.