Knowledge Base

Overview

This article explains how to pull the current CodeGuard plan list into your Web Host Manager Complete Solution (WHMCS) installation after your CodeGuard partner account has been re-provisioned with new or custom plans. By the end, you will have refreshed the CodeGuard module in WHMCS and selected which updated plan to offer by default. It covers when to use this procedure, the prerequisites you need before starting, the module reset and reconfiguration steps, and how to confirm the new plans have loaded.

When to use this procedure

Use this procedure in either of these situations:

• Your CodeGuard partner account was re-provisioned with custom plans.
• The CodeGuard support team has asked you to retrieve the latest plan settings.

Deactivating and reactivating the module is what forces WHMCS to fetch the current plan list from CodeGuard. Deactivating the module does not affect your existing customers or their backups.

Prerequisites

Before you start, make sure you have:

• Administrator access to your Web Host Manager Complete Solution (WHMCS) installation.
• The CodeGuard API key issued when your CodeGuard partner request was approved.
• A decision on which admin roles should be able to access the CodeGuard module.

Steps

1. Log in to WHMCS as an administrator.
2. Go to Setup → Addon Modules.
3. Click the red Deactivate button for the CodeGuard module.
4. Click the green Activate button for the same CodeGuard module.
5. Click Configure for the CodeGuard module.
6. Select the admin roles that may access the CodeGuard module, then click Save Changes.
7. Go to Addons → CodeGuard Website Backup.
8. Enter your CodeGuard API key, then click Save.
9. Review the updated CodeGuard plan list that appears and select the plan you want to offer by default.
10. Complete the remaining pages of the setup wizard: [describe what the final two wizard pages ask the administrator to confirm].

How to verify success

The refresh worked when the plan list under Addons → CodeGuard Website Backup shows your current CodeGuard plans, including any custom plans added during re-provisioning, and your chosen default plan is selected. Existing customer accounts and their backup schedules remain unchanged.

Troubleshooting

Issue: The plan list still shows the old plans after reactivation.

Cause: The module was reactivated before the API key was re-entered, so WHMCS did not request a fresh plan list.

Solution: Repeat steps 3 to 8 in order, making sure you save the API key at step 8.

Issue: The API key is rejected at step 8.

Cause: The key entered does not match the one issued for your approved CodeGuard partner account.

Solution: Retrieve the API key from your CodeGuard partner account approval details and enter it again. If it is still rejected, contact the CodeGuard support team.