WHMCSModule Networks
AUTOMATION PLATFORM ...
Article Guide

Vultr Cloud VPS Automation Installation for WISECP

Vultr Modules• 16 Nov 2026• By WHMCSModule Networks
Home / Docs / Vultr Cloud VPS Automation Installation for WISECP

Sell and manage Vultr Cloud Compute instances from WISECP v5. This guide goes from an empty WISECP install to a customer's first running server. Follow the steps in order; each one ends with a check so you know it worked before moving on.

Contents

  1. Requirements
  2. Install the files
  3. Create a Vultr API key
  4. Add the server in WISECP
  5. Enter the module license
  6. Create a product category
  7. Create the product
  8. Configure the product (every setting)
  9. Set the price
  10. Make sure the cron job runs
  11. Place a test order
  12. Optional: add-ons
  13. Optional: import many plans
  14. Optional: assign reserved IPs and VPCs
  15. Optional: choose which images customers see
  16. Cancelling, upgrading, uninstalling
  17. Troubleshooting

1. Requirements

WISECP v5
PHP 8.2 or newer with curl, json and mbstring
Vultr An account with credit or a payment method, plus an API key
Network The WISECP server can reach https://api.vultr.com on port 443
Cron WISECP's cron is running (the module adds one job, every minute)
License A module license key

2. Install the files

  1. Unzip the package. It contains one folder, VultrCloud/.

  2. Copy it into your WISECP install so the path is:

    <wisecp>/coremio/modules/Servers/VultrCloud/
  3. Make sure the web server user can read the folder. The module never writes inside it.

No database changes are needed.

Check: open Products → Hosting & Servers → Server Settings → Add New Server, click the Virtualization tab, and Vultr Cloud is listed with the Vultr logo.

3. Create a Vultr API key

  1. Sign in to the Vultr customer portal and open Account → API.
  2. Click Enable API, then copy the API key.
  3. Under Access Control, add the public IP address of your WISECP server (or allow all addresses). If your server's IP is not on the list, Vultr answers 403 and the module shows "Vultr rejected the API key".

The key can create, delete and bill resources on your Vultr account. Treat it like a password and use an account dedicated to this WISECP install.

4. Add the server in WISECP

  1. Go to Products → Hosting & Servers → Server Settings and click Add New Server.

  2. Click the Virtualization tab and select Vultr Cloud.

  3. Fill in the form exactly like this:

    Field on the form What to enter
    Hostname A label for you, for example Vultr Production
    API endpoint (fixed, not used) api.vultr.com
    Username (not used) api (any value)
    Password (not used) x (any value)
    Vultr API key Paste your Vultr API key. This is the only value the module uses.
    Monthly Cost, Maximum Accounts, Nameservers Leave the defaults

    WISECP's server form always requires an address, username and password before it enables Save. The module ignores all three and always talks to https://api.vultr.com/v2/, so the values above are placeholders.

  4. Click Test Connection. Then click Add New Server.

Check: the new server appears in Server Settings with status ACTIVE and the Vultr logo.

You can add several servers, one per Vultr account. Each product uses the server you pick on it.

5. Enter the module license

  1. Open the module's admin area: Products menu → Vultr Cloud (address /admin/vultrcloud). It appears once at least one Vultr Cloud server exists.
  2. Open the License tab.
  3. Paste your license key into License key and click Save.

Check: the green banner reads Active: License is active, and the other tabs (Account, Instances, Plans, Resources, App Templates, Logs, Settings, Billing) now load. Until the license is Active, the module refuses to create services or run customer actions.

Then open the Account tab: it should list your Vultr account name, balance and number of instances. That proves the API key works.

6. Create a product category

  1. Go to Products → Server/VPS → Categories and click Create New Category.
  2. Enter a Title, for example Vultr Cloud Servers. Leave Status on and save.

If the title's web address is already used by another page, WISECP tells you; choose a different title.

7. Create the product

  1. Go to Products → Server/VPS and click Create New Product.

  2. Fill in the first form:

    Field Value
    Product Type Servers
    Product Group Server/VPS
    Product Category the category from step 6
    Product Name for example Vultr 1 vCPU / 0.5 GB
    Module Assignment Vultr Cloud (appears after you pick the category)
    Hidden leave on while you configure; turn it off when you are ready to sell
  3. Click Create. You land on the product's edit page.

8. Configure the product (every setting)

On the product edit page open the Automation tab.

8.1 Choose the server

  1. Module Assignment must show Vultr Cloud.
  2. Under Server Configuration, set Server Selection to Single Server and choose the server you added in step 4.
  3. Wait for Module Configuration to finish loading. It is filled live from Vultr, and it can take a few seconds.

8.2 Module Configuration

Setting What it does Recommended value
Region Where the server is created. Empty lets the customer choose at checkout. Pick one region for a simple product. After changing it, Save to refresh the plan list.
Plan The Vultr plan to deploy. Only plans deployable in the chosen region are listed (label shows vCPU, RAM GB, disk GB, price per month). Choose the plan you are selling
Default operating system Installed when the customer does not choose one. A current Debian or Ubuntu LTS
Default Marketplace application Deployed instead of the OS when set and the customer chooses nothing. None
Hostname prefix Used to build a hostname when the order has none. vps
Startup script A Vultr startup script run on first boot. None
Firewall group Attached to every new instance. A shared group can only be edited by staff, never by customers. None
SSH keys Do not install account SSH keys or Install all SSH keys of the Vultr account. Do not install (installing all would give every key on your account access)
Backups by default Turns on Vultr automatic backups (extra cost at Vultr). Off
IPv6 by default Enables IPv6 on new instances. As you prefer
DDoS protection by default Enables Vultr DDoS protection (extra cost at Vultr). Off unless you bill for it
Allow customers to use the web console The console link is tied to your Vultr account. Staff can always use it. Off
Delete the instance at Vultr on cancellation When on, cancelling a service deletes the server so it stops billing. See section 16. On
Snapshots included Snapshots a customer may keep without buying more. 0 hides the Snapshots tool for them. 0 unless you sell snapshots
Firewall rule limit Rules per firewall a customer may add (1 to 50). 25
Reverse DNS template Applied to new instances. Tokens: {ip}, {hostname}. Empty
Cloud-init mode Customer may supply a script, Product default script only, or No user data. Product default script only for most shops
Default cloud-init script Used when the customer supplies nothing, or always in "Product default" mode. 16 KB maximum. Tokens: {hostname}, {serviceid}. Empty
  1. Scroll down and click Save.

Check: reopen the product's Automation tab. The Region, Plan and Default OS you chose are still selected.

8.3 General tab settings worth reviewing

Setting Recommendation
Automatic Setup On, so paid orders are provisioned without manual approval
Restrict Access Off (customers see their server's login details)

9. Set the price

  1. Open the product's Pricing tab.
  2. Set the billing cycles and prices you want to charge. (Vultr bills monthly in USD; prices here are what your customer pays.)
  3. Save.

If you plan to import many plans, you can instead let the module calculate prices. See section 13.

10. Make sure the cron job runs

The module registers one job, Pending Vultr order sync (every minute). It finishes activating servers that Vultr was still deploying when the order was placed.

  1. Make sure WISECP's cron entry from its own installation guide is installed and running.
  2. In the admin go to Tools → Cron Jobs and look for Pending Vultr order sync.

Check: the job is listed. With no pending orders it simply reports "No pending orders."

11. Place a test order

Use the cheapest plan, a throwaway client, and leave DDoS protection and backups off. A server bills from the moment Vultr creates it.

  1. Turn Hidden off on the product (or order for a client from Orders → Create Order).
  2. Create an order for a test client and set the order status to Active.
  3. Open the new service: Services, then the service.
  4. If the service shows a CREATE operation as Pending, click Run Now. (WISECP's cron normally does this for you.)
  5. The module creates the server at Vultr and waits about ten seconds. If Vultr is still deploying, the service stays In Progress; the cron job activates it when the server is ready, usually within a few minutes.

Check:

  • The service becomes ACTIVE and shows the hostname, IP address and root password.
  • Products → Vultr Cloud → Instances lists the server, linked to the service number.
  • The customer's service page shows Running, the operating system and location, and the tools you enabled: Stop, Restart, Force Stop, Reinstall OS, Server Options, Firewall Rules, Reverse DNS, Additional IPs, SSH Keys, IPv6, Bandwidth Usage, ISO Images, Reserved IPs & VPC. (Snapshots, Backups and Additional Disks stay hidden until the product includes them.)

Test one action as the customer, for example Restart Server: a toast says "Restart requested."

When you are finished testing, cancel the test service (section 16) and confirm the server disappears from the Instances tab.

12. Optional: add-ons

Create add-on products under Products → Add-ons and set these parameters in the add-on's module section:

Parameter Value Effect
extra_ip number Extra IPv4 addresses
block_storage_gb number of GB Creates and attaches an NVMe volume
backups 1 Enables Vultr automatic backups
ddos 1 Enables Vultr DDoS protection
snapshots number Extra snapshots the customer may keep

Attach the add-on to the product. Customers see the Snapshots, Backups and Additional Disks tools only if the product includes them or an add-on provides them.

13. Optional: import many plans

  1. Complete steps 6 to 9 for one product. It is the template: every import copies its category, tools and settings and changes only the plan, region, title and prices.
  2. Open Products → Vultr Cloud → Settings and set:
    • Price margin: percent added to Vultr's monthly cost, for example 20.
    • Template product: the product from step 1.
    • Currency rates: for each currency you sell in, the multiplier from USD (Vultr bills in USD). Leave a currency empty to never price in it.
  3. Click Save.
  4. Open the Plans tab, choose a Plan and Region, and click Import. A new product is created with the price Vultr cost × (1 + margin) × rate.
  5. When Vultr changes its prices, click Sync prices. Prices set to 0 and currencies without a rate are never changed.

The import refuses duplicates (same plan and region), plans not offered in the chosen region, and templates that are not Vultr Cloud products.

14. Optional: assign reserved IPs and VPCs

These are account-wide at Vultr, so customers only see the ones you assign to their server.

  1. Open Products → Vultr Cloud → Resources, then Reserved IPs (or VPCs).

  2. Create the object, and in its Label (reserved IP) or Description (VPC) start with the server's ID in square brackets and a space, for example:

    [f3614173-d956-442b-bbce-01ffaba1b344] customer IP

    The server ID is shown on the Instances tab.

  3. The customer now sees it under Reserved IPs & VPC and can attach and detach it.

Reserved IPs cost money at Vultr while they exist, even when detached.

15. Optional: choose which images customers see

Open Products → Vultr Cloud → App Templates. Switch an operating system or Marketplace application off to hide it from customers' Reinstall OS page. Staff can still install anything.

16. Cancelling, upgrading, uninstalling

Cancelling a service

  • Only servers this module ordered are deleted, and only when the product's Delete the instance at Vultr on cancellation is on. The module also removes the firewall group, tagged snapshots, SSH keys and ISOs, and volumes it created for that server.
  • Servers you imported or linked by hand are never deleted by the module.
  • When you cancel from the service page, keep Apply via API ticked. Otherwise only WISECP changes and Vultr keeps billing you. Check afterwards that the server is gone from Products → Vultr Cloud → Instances.

Suspending

Suspend halts the server and Activate starts it again. Keep Apply via API ticked.

Linking existing servers

On the Instances tab, a Vultr server that is not linked to a WISECP service has a Link control: choose the service and click Link. WISECP's normal Import screen also works.

Upgrading the module

  1. Back up coremio/modules/Servers/VultrCloud/.
  2. Replace the folder with the new version. Settings, license and customer data live in WISECP's database, not in this folder.
  3. Open the License tab and confirm the status is still Active. It also shows when a newer version is available.

Uninstalling

  1. Cancel or move every service that uses the module (cancelling deletes their servers).
  2. Remove the Vultr Cloud server records under Server Settings.
  3. Delete coremio/modules/Servers/VultrCloud/.

17. Troubleshooting

Symptom Likely cause and fix
"Vultr rejected the API key" Wrong key, or your server's IP is not allowed under Access Control in Vultr
"Could not reach Vultr" Outbound HTTPS to api.vultr.com is blocked, or PHP's curl is missing
"The module license is not active" Open Products → Vultr Cloud → License and press Re-check; the key is bound to your domain
Product form dropdowns are empty The catalog could not load. Check the server's key and press Test Connection
Service stays In Progress Vultr is still deploying. Check that WISECP's cron is running, or press Run Now on the service
"Invalid plan chosen" The plan is not deployable in that region. Choose a region the plan lists
Customer cannot see Snapshots, Backups or Disks Hidden until the product includes them or an add-on provides them
Cancelled service still billing at Vultr The cancel was applied without Apply via API, or the server was linked by hand. Delete it in the Vultr portal
A save in WISECP fails with an error about an IP lock That is WISECP's own platform license, not this module. Ask WISECP to reissue it for your server's current outbound address (both IPv4 and IPv6)

Staff see the specific Vultr error message; customers only ever see a generic one.

Have Questions About This Article?

Our dedicated support engineers are available 24/7 to assist with your configuration.