codeguard

Reseller should be signed up for the CodeGuard product

Validate Upgrade/Downgrade

Description

Validates upgrade/downgrade for a particular CodeGuard Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order ID of the CodeGuard Order for which upgrade/downgrade needs to be validated
new-planid Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/validate-modify.json?auth-userid=0&api-key=key&order-id=0&new-planid=0

Response

Returns true (String) if upgrade/downgrade is validated successfully.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Get Upgrade/Downgrade Price

Description

Gets the applicable upgrade/downgrade price for a particular CodeGuard Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order ID of the CodeGuard Order for which the details are to be fetched
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method.
months Integer Required The number of months (tenure) in the new plan for which the Order to be placed

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Response

Returns the applicable upgrade/downgrade price for a particular CodeGuard Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"remainingmonths":0,
"currentOrderPrice":0.0
}

where

  • currentOrderPrice: The current pricing of the Order for remaining months.

  • modifiedOrderPrice: New applicable pricing of the Order as per the new plan.

  • upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice

CodeGuard Plan Details

The various CodeGuard Plans offered by and their specifications are listed below:

Plan I Plan II Plan III Plan IV
Storage 1 GB 5 GB 10 GB 25 GB
Websites Up to 5 Up to 10 Up to 25 Up to 100
Databases Unlimited Unlimited Unlimited Unlimited
Automatic Backup Frequency 5 days Daily Daily Daily
Zip file downloads 5/month Unlimited Unlimited Unlimited
Full Website Restore 3/month Unlimited Unlimited Unlimited
Individual File Restore 5/month Unlimited Unlimited Unlimited
On Demand Backups
Priority Queueing

CodeGuard FAQs

Listed below are some Frequently Asked Questions for CodeGuard.

What is CodeGuard?

CodeGuard is a service that provides an automatic website / database backup solution. It monitors your website / database regularly. If any changes are detected, it will notify you about the changes and backup your website / database. It also allows you to restore your website / database to a previous version.

How does CodeGuard connect to my website?

If your website is hosted on 's Linux servers, use the SFTP option. Also, you must use the default FTP user that comes with your cPanel account. You cannot connect to CodeGuard using any other FTP user. For 's Windows servers, use the FTP option.

In case of other hosting providers, you can choose either the FTP or SFTP option, based on your service provider's settings.

Wouldn't the hosting provider's backup suffice?

Hosting companies tend to keep your backups in the same place as your primary files. In case of any eventuality, along with your primary files, your backups too will be affected. CodeGuard provides safe, offsite backup that is 100% independent from your hosting provider.

Moreover, hosting companies provide you only the latest backup. CodeGuard follows a versioning system and allows you to restore a backup of an earlier date as well.

After I add a website, how do I change what files are backed up?

After you add a website, any new files or directories that you add to your site will automatically backed up. CodeGuard will only exclude files and directories that you don't select when adding your website. If you need to change how your website is backed up, you need to delete and re-add your website. However, this should be handled with care as you will lose your backups. This option is only recommended if you have just added your website.

What types of database are supported for backup?

CodeGuard only supports MySQL database.

What database user permissions are needed to backup and restore?

The database user that you specify in CodeGuard must have the appropriate permissions granted. It is recommended that the user has the permissions for both backup and restore actions:

  • Backup

    • Select

    • Show View

    • Show Databases

  • Restore

    • Select

    • Update

    • Insert

    • Delete

    • Drop

    • Create

    • Alter

    • Index

How does CodeGuard store data? Is it encrypted?

CodeGuard uses Amazon Web Service’s Simple Storage Service (S3) to house website and database backup data. All customer backup data is encrypted using an AES-256 bit key.

What is the privacy policy with regards to data captured by CodeGuard?

CodeGuard's privacy policy can be located here.

How long are the backups stored in the CodeGuard account?

By default, only 90 days of backups are stored. You can choose to retain all backups, from the Backup Retention Settings section in the ACCOUNT SETTINGS view. You can navigate to this view through the SETTINGS -> ACCOUNT menu, within your CodeGuard account.

CodeGuard User Guide

This article explains how to get started using CodeGuard to backup and restore your website / database data.

Adding a website to your CodeGuard account

  1. Login to your Control Panel, search for the domain name for which you have purchased this CodeGuard Order and go to the
    Order Information view. See details

  2. Click the View Dashboard link to visit the CodeGuard dashboard.

  3. You will be required to add your website FTP details, if you are logging in to the CodeGuard dashboard for the first time. If you have the FTP details, proceed to step 4 directly.

    If the FTP details are not available, you can fetch them for an existing FTP user. This process is explained below for a couple of commonly used hosting control panels:

    • cPanel:

      1. In the cPanel control panel, click the FTP Accounts link under the Files section.

      2. Under the FTP Accounts section, click the Change Password link for an existing FTP user.

        In case of 's Linux servers, you must use the default FTP user that comes with your cPanel account. You cannot connect to CodeGuard using any other FTP user.

      3. Modify the password for the FTP user.

      4. In the cPanel control panel, look out for the IP address under the Stats section.

    • Plesk:

      1. In the Plesk control panel, click the FTP Access link.

      2. Under the FTP accounts section, click the FTP user link for an existing FTP user.

      3. Modify the password for the FTP user.

        Here, note down the IP address of the server listed in the IP Addresses field.

    Note

    The process of FTP user management varies for different hosting providers. You need to consult their support team or documentation for more specific instructions.

  4. Provide your website FTP details.

    If your website is hosted on 's Linux servers use the SFTP option and for 's Windows servers, use the FTP option.

    Note

    In case of other hosting providers, you can choose either the FTP or SFTP option, based on your service provider's settings.

    If the FTP port for your website is different, you can specify it using the Using a different port? link.

    Click the TEST WEBSITE CONNECTION button to check server connectivity.

  5. On a successful connection, you will see the screen shown below.

    Click the CONNECT YOUR WEBSITE button to proceed.

  6. Select the files you want to backup and click the CAPTURE CODE button.

  7. Once the backup process starts, you can view its progress. You will see the screen displayed below, once the backup process is completed.

Adding a database to your CodeGuard account

  1. Visit the CodeGuard dashboard, as explained above in the process for adding a website. Click on any website link to view the website specific details.

  2. Click on the DATABASES tab.

  3. In the next screen shown below, click the ADD DATABASE button.

  4. During the initial addition of a database to CodeGuard, you can test the server connectivity by providing the database hostname or the IP address.

    You can locate the IP address of the database server as mentioned below:

    • cPanel: In the cPanel control panel, look out for the IP address under the Stats section.

    • Plesk: In the Plesk control panel, click on the Databases link.

      In the next screen, locate the IP address under the Database server column.

    Note

    The process of database management varies for different hosting providers. You need to consult their support team or documentation for more specific instructions.

  5. Click on the TEST CONNECTION button.

  6. You will be required to add your database details. If you have them, proceed to step 7 directly.

    If the database details are not available, you can fetch them for an existing database.

    This process is explained below for a couple of commonly used hosting control panels:

    • cPanel:

      1. In the cPanel control panel, click the MySQL Databases link under the Databases section.

      2. Under the Current Users section, click the database user link for an existing user.

      3. Modify the password for the database user.

    • Plesk:

      1. In the Plesk control panel, click the Databases link.

      2. Here, you can view a list of existing databases. Click the Users tab.

      3. You can now view a list of existing databases users. Click on the user link.

      4. Modify the password for the database user.

  7. On a successful connection, you will see the screen shown below. Enter your database details.

    Before you proceed, for direct MySQL connection, ensure that the IP addresses listed below are whitelisted in your hosting control panel:

    • 184.72.217.230

    • 184.72.217.227

    • 184.72.219.00

    • 54.236.233.28

    • 54.236.233.46

    • 54.235.150.113

    Listed below is the process for whitelisting IP addresses in cPanel:

    1. In the cPanel control panel, click the Remote MySQL link under the Databases section.

    2. Add the IP addresses to the Access Hosts list individually.

    If SSH has been enabled for your hosting account, you can connect to the database over SSH. Here, choose the Tunnel over SSH option.

    In case of 's servers, only the Connect to MySQL directly option is supported.

    Click on the NEXT STEP button to proceed.

  8. Select the database to be added and click on the ADD DATABASE button. CodeGuard will then start an initial backup process.

  9. Once the backup process starts, you can view its progress. You will see the screen displayed below, once the backup process is completed.

This completes the process of adding a website and a database to your CodeGuard account. CodeGuard will now regularly check your website and database and will take a backup if any changes are detected.

View backups taken by CodeGuard

  1. In the CodeGuard dashboard, click on the website or the database link under MY SITES.

  2. In the website / database specifc view that follows, click on the VIEW ALL link to view the backup history interface:

    Note
    • The automatic backup schedule depends on the CodeGuard plan that you have purchased.

    • If your plan supports it, you can initiate an instant backup process by clicking the RUN BACKUP NOW button.

  3. Click on the VIEW DETAILS link corresponding to any backup to view the backup details:

  4. If required, you can delete a website or database through the Delete option under the ACTION menu, corresponding to the website or database.

Restore your data from a backup

  1. In the CodeGuard dashboard, click on the RESTORE tab to bring up the Restore interface:

  2. You can perform an automated test restore on your website to find out if CodeGuard can successfully write to your website, by clicking the START TEST RESTORE button.

    The automated test restore is optional. If you want, you can skip it and move to the 5th step.

  3. You will see the message shown below once the test restore process is completed. Click on the VIEW TEST RESTORE RESULTS button to view the result.

  4. Click on the Close Window button to proceed.

  5. Click on the RESTORE OPTIONS button to view the restore options:

  6. Here, you may choose one of the following restore options:

    • Manual Restore: Perform a manual restore yourself by requesting a zip file of a backup & manually replacing files on your site

    • Full website restore: CodeGuard will automatically restore your website by replacing all of your current content with content from a backup

    • Individual File Restore (applicable only for website restore): Specify a file to be restored and CodeGuard will restore that file from a backup

  7. Select one of the last two restore options to initiate the restore process. Once the backup process starts, you can view its progress. You will see the screen displayed below, once the
    backup process is completed.

Backup Issues

  1. In the CodeGuard dashboard, click on the ISSUES tab to bring up the Backup Issues interface:

  2. Click on the issue link to view the details: