WHMCSModule Networks
AUTOMATION PLATFORM ...
Article Guide

Installation and Configuration of OVH Public Cloud module for WHMCS

OVH Modules• 20 Nov 2026• By WHMCSModule Networks
Home / Docs / Installation and Configuration of OVH Public Cloud module for WHMCS

This tutorial will show you how to successfully install and configure the OVH Public Cloud module for WHMCS. We will guide and help you step by step through the whole process.

The module is made of two parts:

  • Provisioning module (OVHcloud Public Cloud) - creates and manages Public Cloud instances for a WHMCS product and shows the management dashboard in the client area and in the admin service page
  • Addon module (OVH Cloud Manager) - the admin control panel where you add your OVH API accounts, browse instances, manage project users, review the activity log and activate your license

Requirements

  1. WHMCS 8.x or later
  2. PHP 8.2 or later with the curl extension
  3. Outbound HTTPS from your WHMCS server to your OVH API endpoint and to my.whmcsmodule.net (license check)
  4. A valid license key from the client area at https://my.whmcsmodule.net/

Table of different region to generate the API Keys

Reference: OVH Official Reference Page

Region Name URL
ovh-us (OVH US) https://api.us.ovhcloud.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*
ovh-ca (OVH North America) https://ca.api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*
ovh-eu (OVH Europe) https://eu.api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*

Create your app keys/ Obtaining API Keys

  1. Any application that wants to communicate with the OVHcloud API must be declared in advance.
  2. To do this, click the above link based on your region
  3. Fill in your OVHcloud customer ID, password, and application name. The name will be useful later if you want to allow others to use it.
  4. You can also add a description of the application and a validity period.
  5. The Rights field allows you to restrict the use of the application to certain APIs. The module needs GET, POST, PUT and DELETE on /cloud/project/ and on /ip/ (reverse DNS), the links above already include them.
  6. After you validate, note down the Application Key, the Application Secret and the Consumer Key

Downloading and Uploading to WHMCS

  1. Access the client area at https://my.whmcsmodule.net/ to download the module
  2. Extract the downloaded module files to your local environment
  3. Upload the entire 'modules' folder to the main directory of your WHMCS installation, it merges into modules/servers/ovh_cloud and modules/addons/ovh_cloud
  4. No build step or database work is needed, the addon prepares its own tables when you activate it

Activating the Addon and Adding the License Key

  1. Go to System Settings » Addon Modules » OVH Cloud Manager » Activate It
  2. Click on Configure and give access to the admin role groups that should use the module
  3. Go to Addons -> OVH Cloud Manager -> License
  4. Enter your license key and click Activate, the key starts with OVHPublicCloud-Yearly- and the page shows Active once it is verified
  5. The license is checked in the background every 7 days and a short offline period is tolerated, until your license is Active all other pages and the dashboards stay locked

Adding your API Account

  1. Go to Addons -> OVH Cloud Manager -> API Accounts
  2. Enter a name, select the endpoint (ovh-us, ovh-ca or ovh-eu) and paste the Application Key, Application Secret and Consumer Key
  3. Click Save and then click the plug icon (Test) next to the account to confirm the connection, it shows how many projects are visible
  4. You can add several accounts, the secrets are stored encrypted and are never shown again

Creating a Package

  1. Go to System Settings -> Product/Service -> Add a Product
  2. Select the product type and group, give a name and select OVHcloud Public Cloud as the module
  3. Go to Module Settings, select the API Account and click Save changes, the lists below are loaded from OVH so this tab can take several seconds to open (results are cached for 10 minutes)
  4. Select the Project and save, then select the Region and save, then select the Flavor and the Operating System Image and fill the remaining options:
# Setting Notes
1 API Account The account added in the addon
2 Project Shown with its name and the first 8 characters of its id
3 Region Location where the instance is created
4 Flavor Default plan, used when the order has no flavor configurable option
5 Operating System Image Default image, used when the order has no image configurable option
6 Hostname Prefix The instance is named prefix-serviceid
7 Suspend Mode Stop instance or Shelve instance when the service is suspended
8 Monthly Billing Hourly (default) or Monthly billing at OVH
9 SSH Key ID Optional OVH SSH key id used when the client does not provide a key
10 Order Form Styling Optional restyle of the configure product step
11 Paid Images for Clients Disabled by default, enables Windows, cPanel, Plesk and CloudLinux images in the client Reinstall tab
12 Password Login Key only (default) or also enable password login with the service password
  1. Go to the Details tab and switch off Require Domain, an instance does not need a domain
  2. Go to the Pricing tab and set a price in every currency your clients can use, a product without a price in the client currency is hidden on the order form
  3. Choose when the service is set up automatically and do a Save changes

The Instance ID and SSH Public Key custom fields are created for you when you save the product. The Instance ID is admin only, the SSH Public Key is shown on the order form so clients can paste an optional public key.

Optional Configurable Options

  1. Volume (or Volume Size) - the included extra volume capacity in GB, a quantity or a dropdown such as 100 GB. A service with capacity gets a Volumes tab and one volume is created and attached when the order is accepted
  2. Volume Type - optional, classic, high-speed or high-speed-gen2, used for the volumes created by clients
  3. Location, Flavor and Operating System - optional configurable options with these names override the defaults of the product

Placing and Accepting an Order

  1. Place an order as a client, the client can paste an SSH public key in the SSH Public Key field
  2. Go to Orders, open the order and click Accept Order with Run Module Create ticked
  3. The instance is created at OVH, the Instance ID is filled in, the service username becomes the login user of the image (for example ubuntu) and the dedicated IP is set
  4. If Password Login is on, the WHMCS service password is also set as the instance password while the instance is created. OVH accepts the SSH key and the password only when the instance is created, they cannot be added or changed later

Assigning an Existing Instance

  1. Go to Addons -> OVH Cloud Manager -> Instances and select the account and project
  2. Find the instance and type the WHMCS service id in the Service column, then click Assign
  3. The service now shows the dashboard of that instance

Client and Admin Dashboard

  1. Hero - instance name with rename, state, IP and the actions Start, Stop, Reboot, Hard Reboot, Shelve, Unshelve and Enable / Leave rescue mode, only the actions valid for the current state are shown
  2. Overview - details, SSH key, network table with editable reverse DNS, Login details (username, SSH command and the password when Password Login is on) and Application access for application images
  3. Reinstall - images grouped by operating system with a version dropdown, Distribution only and Distribution with application tabs, and action protection
  4. Console - embedded HTML5 console
  5. Volumes - shown when the service has volume capacity, create, attach, detach, increase and delete
  6. Snapshots, Resize (admin only) and Logs
  7. Help - how to reset an operating system password using rescue mode
  8. Billing & Subscription card in the client area with product, cycle, dates, amounts and payment method
  9. Admins can also activate monthly billing on an hourly instance, this cannot be undone at OVH

Project Users

  1. Go to Addons -> OVH Cloud Manager -> Project Users and select the account and project
  2. You can list the project users, create a user with roles, regenerate a password and delete a user
  3. A password is displayed once, right after it is created or regenerated, copy it immediately
  4. If creating a user returns an access denied message, allow POST on /cloud/project/*/user for your consumer key

Suspend, Unsuspend and Terminate

  1. Suspend stops or shelves the instance according to the Suspend Mode, Unsuspend starts, unshelves or resumes it depending on its real state
  2. Terminate deletes the instance, an instance that was already deleted at OVH is treated as terminated, and removes the SSH key registered for the service

Upgrading

  1. Overwrite modules/servers/ovh_cloud and modules/addons/ovh_cloud with the new files
  2. No database step is needed, the addon updates its own tables the next time it loads
  3. Check the changelog before upgrading a production installation

Uninstalling

  1. Deactivate the addon under System Settings » Addon Modules, the dashboards stay locked while the addon is not active
  2. Delete the modules/servers/ovh_cloud and modules/addons/ovh_cloud folders

Now we have successfully installed and created a module

Have Questions About This Article?

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