hosting

If the reseller is selling Web Hosting

Get Details

Description

Gets the details of an existing Web Services 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 OrderId for which the details to be fetched.

HTTP Method

GET

Example Test URL Request


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

Response

Returns the details of an existing Web Services order.

Delete

Description

Deletes an existing Web Services 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 OrderId which is to be deleted.

HTTP Method

POST

Example Test URL Request


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

Response

Returns a map of the execution details of the delete operation.

Modify/Upgrade

Description

Modifies/upgrades an existing Web Services Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId which is to be modified.
new-plan-id Integer Required The new Plan to which the order is to be upgraded/downgraded. To fetch the Plan details i.e. plan-id etc, use this method.
Note
  • The new Plan category can be websitebuilder_plan or email_plan.

  • The new Plan category can be linux_hosting_plan only if the current Plan category is linux_hosting_plan. Similarly, the new Plan category can be windows_hosting_plan only if the current Plan category is windows_hosting_plan. In all other cases, an exception will be thrown if the new Plan category is linux_hosting_plan or windows_hosting_plan.

months Integer Required The number of months in the new Plan for which the Order is to be placed.
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/webservices/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=PayInvoice

Response

Returns a map of the execution details of the modify operation.

Renew

Description

Renews an existing Web Services 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 OrderId which is to be renewed.
months Integer Required The number of months for which the Order is to be renewed.
enable-ssl Boolean Optional Values can be: true or false (default). To learn more, click here.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/webservices/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a map of the execution details of the Renew operation.

Add

Description

Places a Web Services Order for the specified domain name. An Order can be either Email only or Website Builder.

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 is placed.
customer-id Integer Required The Customer under whom the Order should be added.
months Integer Required The number of months for which the Order is placed.
plan-id Integer Required The Plan under which the Order should be added. To fetch the Plan details i.e. plan-id etc., use this method.
Note

The Plan category can be websitebuilder_plan or email_plan. An exception will be thrown if the Plan category is linux_hosting_plan or windows_hosting_plan.

enable-ssl Boolean Optional Values can be: true or false (default). To learn more, click here.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/webservices/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a map with the execution details of the Order addition.

Email, Legacy Web Hosting and Website Builder

Web Services Plans provide you with methods to add, renew, upgrade/modify, suspend, delete and get the details and the pricing for the Website Builder plans.

Note

The Legacy Linux, Windows Hosting Products and Email only plans offered by have been deprecated w.e.f. April 16, 2013 and Feb 2, 2015 respectively. You may only renew, suspend, delete, get the details and the pricing for these Products Plans.

IMPORTANT: cPanel Linux Hosting package User Guide

The information listed below describes the various sections and buttons/features visible within your cPanel Linux Hosting package with
. Clicking on the link besides the features listed below
may require you to navigate to the precise documentation for cPanel ver. 11.40.

Accessing cPanel

The cPanel Home Screen

Help

Clicking the Help button (or the Help link at the bottom of the screen) opens a pop-up window
with information regarding the feature you have accessed within the cPanel interface. The contents of the Help menu change, depending on where you are in the interface.

Find

This functionality helps you to locate a feature within your cPanel.

Frequently Accessed Areas

This feature lists your 5 most accessed features within your cPanel.

Stats Menu

This feature lists details about your cPanel Linux Hosting package as well as versions of the software installed on this server.

Preferences

Video Tutorials

Within your cPanel and under this menu item you would find several video tutorials of cPanel features. However, only the following tutorials describe the features available within your cPanel:

  • My SQL: A guide to creating and modifying MySQL databases in cPanel.

  • Updating Your Contact Information: Change your contact information as well as preferences.

  • Shortcuts: Easily access your cPanel by adding cPanel shortcuts to your desktop or browser's bookmarks toolbar.

  • Subdomains: Learn all about creating and managing subdomains.

  • MySQL Wizard: Create and manage MySQL databases with this step by step wizard.

  • Parked Domains: Learn about creating and managing parked domains.

  • Redirects: Learn how to make a specific web page redirect to another page and display the contents of that page with redirects

  • Password Protect Directories: Learn how to limit access to a certain part of your site by requiring a user name and password to access a folder or folders from the web.

  • Hotlink Protection: Prevents other websites from directly linking to files on your website.

  • IP Deny Manager: Block a range of IP addresses to prevent them from accessing your site.

  • Site Software: Blogs, Bulletin Boards, CMS, Chat, Ecommerce, and more!

  • File Manager: Quickly manage all of your files with the new File Manager.

  • Backups: Download (to your computer) a zipped copy of either your entire site (your home directory, databases, email forwarders configuration, email filters
    configuration) or one of the previously mentioned parts of your site.

  • Ftp Accounts: Access your web site's files through FTP.

  • Web Disk: Easily drag and drop files to your hosting account.

Update Contact Info

This feature allows you to update your email address where you would want to be contacted about your package.

Change Language

This allows you to change your cPanel interface display language.

Shortcuts

This functionality allows you to create a shortcut to your cPanel interface within your favorite web browser.

Note

Files (Anchor: files)

FTP Accounts

This interface allows you to add and manage FTP accounts.

Note

FTP Session Control

This feature displays information about and gives you control over who is connected to your account via FTP.

Disk Space Usage

This feature displays information about how and how much disk space is being used by your website.

File Manager

This feature allows you to upload/manage files through your Web Browser itself.

Legacy File Manager

This is an older version of the File Manager feature.

Web Disk

This feature allows management of files directly through your computer's Operating System.

Backup Wizard (Anchor: backup)

The Backup Wizard is a user-friendly interface for creating a backup of the entire site, a partial backup, or
allowing a site restoration from the last backup you saved.

Backups

This feature provides an interface for downloading and storing all or some of the website's files, databases, forwarders and filters.

Logs

Bandwidth

This feature allows you to see how your website's bandwidth is being used.

Latest Visitors

This feature that displays information about the last 300 people to visit your site.

Awstats

This feature allows you to access web statistics processed by the AWStats software.

Raw Access Logs

This feature allows you access to your website's logs for viewing and processing statistics offline.

Error Log

This feature displays the last 300 errors encountered by your website.

Security

Note

's cPanel Linux Hosting packages only support the SymLinksIfOwnerMatch option
in the .htaccess file. See details

Password Protect Directories

This feature allows you to restrict access to certain parts of your website.

IP Deny Manager

This feature is capable of blocking a single IP address or a range of IP addresses from accessing your website.

SSL/TLS Manager (Anchor: digicert)

This feature allows you to manage SSL/TLS keys, certificates, and signing requests.

Note
  • Prior to installing/uploading a Digital Certificate, you need to enable SSL support for your cPanel Linux Hosting package
    through . See details

  • How-to for SSL/TLS Manager

    If you have purchased a Digital Certificate through , then apart from installing the Digital Certificate, you would
    need to also install the thawte Cross Root CA and Intermediate CA.
    See details

HotLink Protection

This feature allows you to prevent other websites from stealing bandwidth of your package.

Leech Protection

This feature allows you to prevent users from sharing passwords publicly.

Domains (Anchor: domains)

Subdomains

This feature allows you to create and manage sub-domains of the domain name for which you have purchased this cPanel Linux
Hosting package. Sub-domains point to a directory within your public_html directory.

Parked Domains

This feature allows you to create and manage domain names that you want to point/redirect to the domain name, for which you
have purchased this cPanel Linux Hosting package.

Note
  • How-to for Parked Domains

  • For each Parked Domain, you would need to point this parked domain name to your primary domain name (for which you have bought cPanel Linux Web Hosting).
    In order to achieve this, you need to either:

    Option 1:

    On the existing Name Servers of the Parked Domain, create 2 Address Records (A Records) pointing to your primary domain name's IP Address. The Address Records can be viewed by
    clicking the Name Server Details link within the Order Details view page of the cPanel Linux Web Hosting package. Notice the first 2 Address Records and request your
    current DNS Service Provider to replicate them for your alias domain name.See details

    Option 2:

    If you have registered the Parked domain name through and your current DNS Service Provider does not allow you
    to create these Records, then you can follow the process listed below:

    • Search for the domain name for which you have purchased the Web Hosting package and go to the Order Details view.
      See details

    • Click the Name Server Details link and note the first 2 Address Records.

    • Replicate these Address Records for the Parked domain name that you wish to add to your cPanel Linux Web Hosting package, from within the DNS interface of the Parked
      domain name. See details

Redirects

This features allow you to create and manage domain redirection or domain forwarding for a Parked Domain.

Note
  • How-to for Redirects

  • For Redirection to work, the Parked Domain needs to point to the Primary domain name for which you have purchased a cPanel Linux Hosting package. To accomplish
    this you have the following 2 options:

    Option 1:

    On the existing Name Servers of the Parked Domain, create 2 Address Records (A Records) pointing to your primary domain name's IP Address. The Address Records can be viewed by
    clicking the Name Server Details link within the Order Details view page of the cPanel Linux Web Hosting package. Notice the first 2 Address Records and request your
    current DNS Service Provider to replicate them for your alias domain name. See details

    Option 2:

    If you have registered the Parked domain name through and your current DNS Service Provider does not allow you to
    create these Records, then you can follow the process listed below:

    • Search for the domain name for which you have purchased the Web Hosting package and go to the Order Details view.
      See details

    • Click the Name Server Details link and note the first 2 Address Records.

    • Replicate these Address Records for the Parked domain name that you wish to add to your cPanel Linux Web Hosting package, from within the DNS interface of the
      Parked domain name. See details

Databases

MySQL Database Wizard

This interface provides step by step instructions for setting up a MySQL database, along with the requisite accounts and privileges.

MySQL Databases

This feature allows you to create a database, add and manage users, check a database for errors, repair a database and link a
database to an existing user account.

phpMyAdmin

This tool allows you to manipulate MySQL databases from within your cPanel interface.

Remote MySQL

This feature allows you to configure databases to be accessed remotely, by other web servers.

Software / Services

CGI Center

The cPanel CGI Center provides a few CGI scripts that can do many useful things for your website.

Site Software

This interface allows you to add useful software to your website.

Note
  • How-to for Site Software

  • The Fantastico De Luxe (Anchor: fantastico) feature provides a
    wider array of scripts, that can be installed, upgraded and removed from your website with just a few clicks. We
    recommend clicking the Fantastico De Luxe button under the Software / Services section.

PHP PEAR Packages

Using these features you can add and manage PHP packages.

PHP Configuration

This feature allows you to view specific information about your server's PHP configuration.

Perl Modules

This feature provides an interface for you to add and manage Perl modules.

Optimize Website

This feature can automatically compress content on your website, when that content is requested by visitors.

Advanced

Apache Handlers

This interface allows you to add and manage Apache handlers. Apache handlers control how your site's Apache web server
software manages certain file types and file extensions.

Index Manager

This interface allows you to configure how a directory index will appear to those who access it.

Error Pages

This interface allows you to customize the appearance of your error pages. An error page informs a visitor when there is a problem
accessing your site.

Cron Jobs

This feature allows you to set scheduled tasks that take place at predefined times or intervals on the server.

Network Tools

This area of cPanel's interface contains tools for retrieving network information.

MIME Types

This feature allows you to create and manage MIME types. MIME types relay information to the browser about how to handle file extensions.

DNS

To Manage DNS Records of your Domain Name

Note

Modifying the DNS Records created by our System for your cPanel Linux Hosting package may cause interruption to your hosting package.

Email Hosting

Troubleshooting

Accessing/Managing your cPanel Linux Hosting package

There are 3 methods by which you can manage your cPanel Linux Hosting package with :

Managing your cPanel Linux Hosting package through your Control Panel with

Note

This method is recommended if you yourself are managing your cPanel Linux Hosting package.

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

  2. Click the Manage Web Hosting link to get automatically logged into your cPanel interface.

Managing your cPanel Linux Hosting package through an IP Address

Note

This method is typically recommended if you wish to delegate management of your cPanel Linux Hosting package to a Web Designer and have not modified your domain name's Name Servers
to the ones recommended by or created the necessary DNS Records on your existing Name Servers.

Alternatively, you may only provide FTP access to your Web Designer by creating another FTP User for him/her. See details

Retrieving the IP Address and Login credentials of your cPanel Linux Hosting package

  1. Login to your Control Panel, search for the domain name for which you have purchased the cPanel Linux Hosting Order and go to the
    Order Details view. See details

  2. Click the Admin Details link.

  3. Your cPanel IP Address is visible next to the Address field, under cPanel Login Details.

    Note

    Your cPanel IP Address would stop being displayed under the cPanel Login Details section, once you have either modified the Name Servers of your
    domain name to those provided by or have created the necessary DNS Records on your existing
    Name Servers. See details

    You may retrieve the IP Address of your cPanel Linux Hosting package by managing your cPanel Linux Hosting package through the
    Control Panel See details
    and once logged in, obtain it from the field IP address.

  4. Your cPanel Password on the other hand can be retrieved from, either:

    • the email that was sent to you upon purchasing this package, or

    • by clicking the Reset Password link to get the Password emailed to your Control Panel Username (Email Address).

      Note

      If your Customer clicks the Reset Password link, only he/she would receive the login credentials. If you have clicked
      the Reset Password link, then both yourself and your Customer would receive the login credentials.

Managing your Plesk Windows Hosting package through your domain name (Anchor: logDName)

Note
  • Prior to accessing the Plesk interface through your domain name, you should ensure that you have either modified the domain name's Name Servers to those provided
    by or have created the necessary DNS Records on your existing Name Servers.
    See details

  • This method of accessing the Plesk Windows Hosting package is recommended if you wish to provide Plesk access to your Web Designer.

  • Alternatively, you may only provide FTP access to your Web Designer by creating another FTP User for him/her. See details

Retrieving the Login Credentials of your Plesk Windows Hosting package

  1. Login to your Control Panel, search for the domain name for which you have purchased the Plesk Windows Hosting Order and go to the
    Order Details view. See details

  2. Click the Admin Details link.

  3. Your Plesk URL is visible next to the Address field, under Plesk Login Details.

  4. Your Plesk Password on the other hand can be retrieved from, either:

    • the email that was sent to you upon purchasing this package, or

    • by clicking the Reset Password link to get the Password emailed to your Control Panel Username (Email Address).

      Note

      If your Customer clicks the Reset Password link, only he/she would receive the login credentials. If you have clicked the Reset Password
      link, then both yourself and your Customer would receive the login credentials.