Module and release scope
This guide covers Webuzo Hosting Control Panel 1.0.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 |
|---|---|---|---|
host — Panel hostname or IP |
text | Yes | Hostname or IP only. HTTPS and certificate verification are required. |
port — HTTPS port |
integer | No | Default: 2005 |
username — Administrator username |
text | Yes | Use the account-specific value described below. |
auth_mode — Authentication method |
select | No | Default: "password" Choices: password = Username and password, api_key = API key |
password — Administrator password |
secret | No | Use the account-specific value described below. |
api_key — API key |
secret | No | Generated in Webuzo Settings → API keys. Used only with API key authentication. |
default_nameservers — Default nameservers |
text | No | Comma or space separated hostnames. |
allow_writes — Allow account changes |
boolean | No | Default: false |
automation — Allow automatic provisioning |
boolean | No | Default: false |
allow_automated_suspend — Allow automatic suspension |
boolean | No | Default: false |
allow_automated_unsuspend — Allow automatic unsuspension |
boolean | No | Default: false |
allow_automated_terminate — Allow automatic termination |
boolean | No | Default: false |
API 1 server module for Webuzo multi-user administration. Installation leaves the module disabled and creates no server connection, accounts, packages, credentials or business settings.
Configure
- Enable the module under Hosting servers → Available and create a connection.
- Enter the plain administrator hostname or IP, HTTPS port (normally 2005), administrator username and selected authentication method. Supply either its login password or a key generated in Webuzo Settings → API keys. Do not enter a URL path. Install a trusted TLS certificate matching the hostname. Private server IPs are allowed, but certificate verification is mandatory.
- Restrict firewall access to the billing server and use an administrator/reseller identity permitted to list plans/users and manage only the intended hosting customers. Password mode uses HTTP Basic authentication. API key mode sends
apiuserandapikeyin the HTTPS form body, including read-only requests; credentials never appear in URLs. - Create shared hosting plans in Webuzo first. Test the connection and explicitly refresh package inventory. Select the exact plan slug, rather than its display name, for the product. The read-only
add_userAPI form exposes the plan catalogue, as used by Webuzo's official billing modules. - Set default nameservers as comma or space separated hostnames. Existing customer domain registrations are not changed by this setting.
- Enable Allow account changes only when ready. Allow automatic provisioning, suspension, unsuspension and termination are separate switches and are all off by default.
Supported operations
Create shared hosting user and primary domain, read/synchronize account, suspend, unsuspend, change plan and delete account. Creation supplies the reserved username/password and real customer email. A fresh user inventory must match the exact username, primary domain, selected plan and account status before an operation is confirmed. New username/domain duplicates are refused. Reseller creation, clusters, automatic server selection, VPS provisioning and dedicated server lifecycle are not advertised by this module.
The API test only reads plans and accounts; it never creates or removes users. There is no separate sandbox: use a dedicated Webuzo test server for acceptance testing. No payment webhook is needed.
A create timeout or rejected confirmation keeps the operation unconfirmed. Check the Webuzo user list and synchronize the reserved username before retrying; the module never automatically repeats a write. Configuration and transport errors are redacted. Unknown statuses are rejected rather than reported as active. Panel account confirmation does not certify DNS propagation, certificates or website availability.
Provider documentation
- Administrator authentication
- Add user
- List users
- Edit user
- Suspend user
- Unsuspend user
- Delete user
- Official SDK and billing module downloads
The module deliberately retains TLS verification even where vendor example scripts disable it. Responses are bounded to 2 MiB, compressed replies are refused, redirects are disabled and writes are not retried.
Termination also requires a fresh API read showing that the exact remote hosting account is suspended. A local billing status alone does not authorize deleting an active remote account.