Integration · 16 min read
cPanel / WHM integration guide
cPanel / WHM connects supported hosting control panels workflows to LucidCP. Use this checklist to configure, link and validate the module before production traffic.
Procedure
Step-by-step
-
01
Prepare the provider account and plan
Confirm that your cPanel / WHM account is active, create the panel hostname, port and a scoped administrator API credential and prepare the provider-side package, plan or template that LucidCP will sell. Record its exact identifier and use a test environment when available.
Step 1 of 16 · Prepare the cPanel / WHM endpoint, scoped credentials and exact upstream package or template identifier.Select the preview to inspect the full-resolution interface. -
02
Confirm the module is available
Open Developer → Modules & Gateways and verify that the cPanel / WHM module is installed and available before creating a connection or product.
Step 2 of 16 · Confirm that cPanel / WHM is available in Developer → Modules & Gateways.Select the preview to inspect the full-resolution interface. -
03
Start the server connection
Open Infrastructure → Servers, select Add Server and choose cPanel / WHM as the module.
Step 3 of 16 · Start a new cPanel / WHM connection from Infrastructure → Servers.Select the preview to inspect the full-resolution interface. -
04
Enter credentials and test the connection
Enter the endpoint, port and scoped credentials in the cPanel / WHM form. Keep TLS verification enabled where supported, run the connection test and resolve authentication, network or permission errors before continuing.
Step 4 of 16 · Complete the real cPanel / WHM connection form and pass its connection test.Select the preview to inspect the full-resolution interface. -
05
Create a compatible server group
Open Server Groups, add the saved connection and choose the placement strategy. Keep every server in the group on the same module and compatible package catalogue.
Step 5 of 16 · Group compatible cPanel / WHM connections and choose how new orders are placed.Select the preview to inspect the full-resolution interface. -
06
Create the LucidCP product package
Open Products / Services → All Products, create a product category if needed, then select New Product. Use one LucidCP product for each package customers should be able to order.
Step 6 of 16 · Create the sellable LucidCP product package from Products / Services.Select the preview to inspect the full-resolution interface. -
07
Complete package details
On the Detail tab, set the package name, category, descriptions, visibility, stock and order limits. Keep the product hidden while the automation is being tested.
Step 7 of 16 · Complete the package identity, catalogue placement, visibility and ordering rules on the Detail tab.Select the preview to inspect the full-resolution interface. -
08
Describe the server features
On Server Features, add the customer-facing feature list and structured CPU, RAM, disk and traffic values used by storefront comparison tables.
Step 8 of 16 · Add package features and structured specifications exactly as customers should see them.Select the preview to inspect the full-resolution interface. -
09
Map the automation and provider package
On Automation Settings, select the cPanel / WHM server or server group and enter the exact provider-side package, plan or template identifier. Complete every module-specific field shown for the selected connection.
Step 9 of 16 · Map cPanel / WHM, the server group and the exact upstream package in Automation Settings.Select the preview to inspect the full-resolution interface. -
10
Set provisioning behaviour
Enable Automatic Provisioning only after the mapping is complete. Review module-specific resource, operating-system, network, credential and lifecycle controls; required fields vary by cPanel / WHM.
Step 10 of 16 · Review the lower module-specific package fields and decide whether paid orders provision automatically.Select the preview to inspect the full-resolution interface. -
11
Configure pricing and billing cycles
On Pricing, enter only the cycles you sell, choose the default cycle and set any one-time setup fee. Confirm currency and tax treatment before publishing the package.
Step 11 of 16 · Set recurring prices, the default billing cycle, setup fee and tax behaviour.Select the preview to inspect the full-resolution interface. -
12
Add options, requirements and upgrades
Attach optional add-ons, required customer inputs and valid upgrade targets where the package needs them. Do not duplicate values that the cPanel / WHM module already controls automatically.
Step 12 of 16 · Attach only the optional add-ons, order requirements and upgrade paths required by this package.Select the preview to inspect the full-resolution interface. -
13
Save and verify the storefront package
Save the product, re-open each tab to confirm the values persisted, then inspect the customer store preview for the name, features, available cycles and order requirements.
Step 13 of 16 · Verify the completed package in the customer store before accepting a live order.Select the preview to inspect the full-resolution interface. -
14
Run a controlled test order
Place a non-production order, complete its invoice and confirm that LucidCP performs account create, suspend, unsuspend, terminate and single sign-on. Check both the LucidCP service record and the provider-side result.
Step 14 of 16 · Complete an end-to-end test order and confirm that provisioning uses the intended package settings.Select the preview to inspect the full-resolution interface. -
15
Verify customer delivery
Open My Services in the customer workspace and confirm that the delivered cPanel / WHM service, credentials, status, usage information and supported actions are shown correctly.
Step 15 of 16 · Check the delivered cPanel / WHM service and its available customer controls.Select the preview to inspect the full-resolution interface. -
16
Monitor provisioning after launch
Review the module queue, failed jobs, activity log and provider log during the first production orders. Correct the underlying mapping or provider error before retrying a failed action.
Step 16 of 16 · Follow provisioning jobs and investigate any failed module action before retrying it.Select the preview to inspect the full-resolution interface.
Checklist
Best practices
- Start with the smallest API permission set and expand only when a documented action requires it.
- Rotate provider credentials regularly and immediately after a suspected leak.
Reference
Module details
- Integration
- cPanel / WHM
- Category
- Hosting Control Panels
- Availability
- Included with licence
- Directory page
- View integration profile
