Vultr Cloud Manager for WHMCS — Installation Guide
Vultr Cloud Manager by WHMCSModule Networks sells and manages Vultr cloud servers from WHMCS. It has two parts that are installed together:
| Part | Folder | Purpose |
|---|---|---|
| Provisioning module | modules/servers/vultr_cloudv2/ |
Creates, suspends, unsuspends and terminates servers; client and admin server dashboard |
| Addon module | modules/addons/vultr_cloudv2/ |
Vultr accounts and API keys, plan import, resource pages, activity log, license |
Requirements
- WHMCS 8.x
- PHP 8.1 or newer, with the cURL extension
- A working WHMCS cron (the module's daily tasks run from it)
- A Vultr account with an API key (see Step 3)
- A license key beginning with
VultrCloud-Yearly-
1. Upload the files
Copy the two module folders from the package into your WHMCS root, keeping the paths:
<whmcs root>/modules/servers/vultr_cloudv2/
<whmcs root>/modules/addons/vultr_cloudv2/
No Composer step is needed. The module classes load through WHMCS's own module autoloading.
2. Activate the addon
- Log in to the WHMCS admin area.
- Go to Configuration → System Settings → Addon Modules.
- Find Vultr Cloud Manager and click Activate.
- Enter your License Key and click Save Changes.
- Under Access Control, tick the admin roles that may use the addon.
Activation creates the module's database tables automatically. If activation reports that the provisioning module must be installed first, check that the modules/servers/vultr_cloudv2/ folder was uploaded.
3. Create a Vultr API key
- In the Vultr customer portal open Account → API.
- Click Enable API and copy the key.
- Under Access Control, allow the public IP address of your WHMCS server. Vultr rejects requests from any other address with HTTP 401.
Treat the key as a password. It is stored by the addon and shown masked in the admin area.
4. Add the API key to the addon
- Open Addons → Vultr Cloud Manager → Accounts.
- Add an account with a name and the API key. You can add several accounts, for example one per Vultr team.
- Use the connection test. A successful test shows the Vultr account holder's name.
The addon opens on the License page until a valid key is stored. All other pages stay locked until then.
5. Import a plan as a product
- Open Addons → Vultr Cloud Manager → Catalog → Plans.
- Pick the account and click Load.
- Click Import as product next to the plan you want to sell.
- Choose the Region, the Product group and the Product name, and set a Markup (percent) over Vultr's price if you want one.
- Confirm the import.
Only regions where the plan is actually sold are offered.
The import creates a WHMCS product that uses the vultr_cloudv2 module, with configurable options for operating system, backups, IPv6, extra IPv4, block storage, snapshots and DDoS protection, plus custom fields for the cloud-init script and SSH keys.
Then open the new product's edit page and click Save Changes once. WHMCS only registers the module's hooks after the product has been saved.
Use Re-sync next to an imported product whenever Vultr prices or options change.
6. Check the product
Open the product under Configuration → System Settings → Products/Services and confirm:
- Module Settings shows the module
vultr_cloudv2, the Vultr account, plan and region. - Custom Fields contains the admin-only Instance ID field. The module creates it. Do not delete it. The server's ID is stored only there.
- Pricing matches what you want to charge.
7. Test an order
- Place an order for the product as a client.
- In the admin area, accept the order with Run Module Create ticked.
- Open the service. Its status becomes Active, and the Instance ID, IP address and the Vultr dashboard appear.
A new server can be locked by Vultr for a minute or two after creation. If the extras you ordered (extra IPv4, block storage) were not applied on the first run, wait, then run Create again from the service page. It applies only what is missing.
What the module does on each service action
| Action | Result on Vultr |
|---|---|
| Create | Deploys the server, then applies ordered extras (backups, IPv6, extra IPv4, block storage, snapshot allowance, DDoS) |
| Suspend | Halts the server |
| Unsuspend | Starts the server |
| Terminate | Deletes the server, releases extra IPv4 addresses, and deletes the block storage volumes, snapshots, firewall groups and SSH keys that belong to that service |
| Change Password | Not supported by Vultr on an existing server. Reinstall from the dashboard to get a new password |
Resources the client created are matched to their service by a [s<service id>] prefix in the name or description. Anything without that prefix, including reserved IPs and VPCs, is never deleted. If a cleanup step fails, the termination still completes and the activity log records an entry named Cleanup Incomplete that lists what remains.
Choosing operating systems
Vultr rejects some operating systems on small plans. For example, Ubuntu 24.04 needs at least 1000 MB of memory and fails on a 512 MB plan. For small plans, restrict the operating system options on the product to suitable Linux images such as Debian 12.
Where to look when something fails
- Addons → Vultr Cloud Manager → System → Logs: every user and system action, and provisioning errors.
- Utilities → Logs → Module Log: each Vultr API call with its response. Keys are masked.
- The service page in the admin area shows the sanitized error from the last module command.
| Symptom | Likely cause |
|---|---|
| HTTP 401, "API key expired" | The key was revoked, or your server's IP is not allowed in Vultr's API access control |
| "Select a plan and a region" on import | The plan is not sold in the selected region. Pick another |
| Service stays Pending after Create | The create failed. Read the error on the service page and the activity log |
| Dashboard tabs show "Loading..." for a long time | Vultr is busy with a snapshot or reinstall. Wait, then reload |
Upgrading
- Back up your database and the two module folders.
- Upload the new files over the old ones.
- Open Addons → Vultr Cloud Manager. Tables are brought up to date automatically.
- Open each imported product and click Save Changes once.
The version number is shown in the footer of every addon page.
Uninstalling
- Terminate or reassign any services that still use the module.
- Deactivate the addon under Addon Modules. Its data tables are kept.
- Delete the two module folders.