codeguard

Reseller should be signed up for the CodeGuard product

CodeGuard Plan Details

The various CodeGuard Plans offered by firstfoot Interactive Pvt Ltd. 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 firstfoot Interactive Pvt Ltd.'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 firstfoot Interactive Pvt Ltd.'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.



Can I upgrade/downgrade my CodeGuard order?

Yes, you can upgrade or downgrade your existing Codeguard package. In order to downgrade your plan, make sure your resources ( disk space, websites) are within the limits of the lower plans.

To switch plans you can click on the See plans and pricing button on the Order Details page.

CodeGuard Getting Started 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 firstfoot Interactive Pvt Ltd.'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 firstfoot Interactive Pvt Ltd.'s Linux servers use the SFTP option and for firstfoot Interactive Pvt Ltd.'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. Select the root directory of your website and click on the Select Root Directory button to proceed.

  6. Select the files you want to backup and click on the Begin First Backup 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 the Databases tab.

  2. In the next screen shown below, click the Add Database button.

  3. 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.

  4. Click on the Test Connection button.

    Before you proceed, for direct MySQL connection, ensure that the IP addresses provided by CodeGuard are whitelisted in your hosting control panel.

  5. You will be required to add your database details. If you have them, proceed to step 6 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.

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

    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 firstfoot Interactive Pvt Ltd.'s servers, only the Connect to MySQL directly option is supported.

    Click on the Next Step button to proceed.

  7. Select the database to be added and click on the Add Databases button. CodeGuard will then start an initial backup process.

  8. 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 specific view that follows, click on the View All button 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 Results button to view the result.

  4. Click on the Restore Options button to view the restore options:

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

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

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

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

  6. 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:

Accessing your CodeGuard Order

From the CodeGuard dashboard, you can access and manage your CodeGuard account (view backups of your website/database, restore from older backups, etc.). You can access the CodeGuard dashboard as explained below:

  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.

Get Reseller Pricing

Description

Use this method to get details of the pricing for the CodeGuard plans for your Sub-Resellers.

Response

Returns a map with the prices of the CodeGuard plans along with the prices of the other products.

The response structure for the CodeGuard product will be:


"productkey":
{
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"codeguard":
{
"plans":
{
"229":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
},
"230":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"231":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"232":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
}
}

Get Customer Pricing

Description

Use this method to get details of the pricing for the CodeGuard plans for your Customers.

Response

Returns a map with the prices of the CodeGuard plans along with the prices of the other products.

The response structure for the CodeGuard product will be:


"productkey":
{
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}

Example:


"codeguard":
{
"plans":
{
"229":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
},
"230":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"231":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"232":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
}
}

Search Orders

Description

Gets a list and details of the CodeGuard Orders matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Orders to be fetched
page-no Integer Required Page number for which details are to be fetched
order-id Array of Integers Optional Order IDs of the CodeGuard Orders whose details need to be fetched
reseller-id Array of Integers Optional Reseller IDs whose CodeGuard Orders need to be fetched
customer-id Array of Integers Optional Customer IDs whose CodeGuard Orders need to be fetched
show-child-orders Boolean Optional Whether Sub-Reseller Orders need to be fetched or not
status Array of Strings Optional Status of the Order: Active, InActive, Suspended or Deleted
domain-name String Optional Name of the Domain of the CodeGuard Order
creation-date-start String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the CodeGuard Orders whose expiry date is less than expiry-date-end
order-by Array of Strings Optional One or more parameters by which you want to sort the Orders. Default is orderid.

Example:

If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid.
If page-no is 2, no-of-records is 30 and order-by is orderid; it will fetch the second batch of 30 Orders sorted by orderid.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map containing the below details of the CodeGuard Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Creation Timestamp (orders.creationtime)

  • Order Expiry Timestamp (orders.endtime)

  • Current Order Status (entity.currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

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

Get Order Id

Description

Gets the associated CodeGuard Order ID from the domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The domain name for which the Order ID is to be fetched

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.com

Response

Returns the associated CodeGuard Order ID (Integer) for the specified domain name.

Get Plan Details

Description

Use this method to get details of your plans.

Response

Returns details of the plans of the CodeGuard product, along with the plan details of other Products of the Reseller.

Example:

The response structure for the CodeGuard product will be:


"codeguard":
{
"plan-id":
{
"plan_name":"Plan Name",
"plan_status":"(Active or Paused)"
},
},

Get Details

Description

Gets the details of an existing 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 Order for which the details are to be fetched

HTTP Method

GET

Example Test URL Request


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

Response

Returns a hash map containing the below details:

  • Order ID (entityid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Product key (productkey)

  • Product Category (productcategory)

  • Plan ID of the CodeGuard Plan (planid)

  • Status of the CodeGuard Plan (paused)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by RID (parentkey)

  • Customer ID Associated with the Order (customerid)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Order Deletion is Allowed (allowdeletion)

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