rhlinux

True if reseller signed up for any RH Linux Product (US or IN or UK)

cPanel Reseller Linux Hosting Package User Guide

The information listed below describes the various sections and buttons/features visible within your cPanel Reseller Linux Hosting Package with
.

Accessing cPanel

Uploading Content to your Website

To upload content to your Website through an FTP client, use only FTPS on Port
21
. (Anchor: ftps)

Some FTP clients support both FTPS modes: Explicit and Implicit. In such FTP clients, the Explicit (FTPES) mode needs to be selected.

List of Popular FTP Clients that Support FTPS

Using cPanel (Anchor: cpanel)

Note
  • All instructions for using your cPanel interface are available in the cPanel User
    Guide. See details

  • Management of both Email and DNS is available in your cPanel interface itself.

The following is a list of limitations with regards to some of the features mentioned in the above-mentioned User Guide:

  • Shell access: Your cPanel Account does not allow access via any shell client. You may instead either use FTP
    or use the File Manager interface within your cPanel Account to upload content.

  • cPanel Password Modification: You may reset your main cPanel Password from your cPanel interface itself. However, you will also have to then update it within the your Control Panel. See details

Softaculous (Anchor: softaculous)

The Softaculous 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 Softaculous button under the
Software / Services section, within your cPanel interface.

WHMCS (Anchor: whmcs)

WHMCS is an all-in-one client management, billing & support solution for online businesses. It can be installed from the WHMCS section under the E-Commerce cateogry, within the Softaculous feature. A License Key is required for the installation of WHMCS, which can be obtained from the Order Information view of the Reseller Linux Hosting Order.

To Request/View a WHMCS License Key

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

  2. Click the WHMCS link.

  3. Here, you can perform the following actions:

    • Requesting the License Key: Click the Request Key button to generate it.

    • Viewing the License Key: Once you have requested a License Key, it will be displayed here.

The information listed below describes the various sections and buttons/features visible within your WHM Account with
. Clicking on the link besides the features listed below
may require you to navigate to the precise documentation for WHM ver. 11.34.

Accessing WHM

Using WHM (Anchor: WHM)

The WHM Home Screen

Find

This functionality helps you to locate a feature within your WHM. Simply type a keyword into the Find box on the top left side of the screen. The menus on the left will automatically filter to show the results.

To show all features of WHM, click the X button to the right of the Find text box.

Server Configuration

Basic cPanel & WHM Setup

Nameservers

This section of the interface allows you to specify nameservers associated with your server. To use this feature, simply enter the nameservers you wish to you use as your primary, secondary, tertiary, etc. nameservers in the appropriate fields and click the Save Changes button.

Support

Configure Customer Contact

This feature allows you to specify how customers should contact you with support requests.

Locales

Locale XML Download

This feature allows you download an existing locale (language) in XML format

View Available Locales

This interface allows you to view available locales, cross-referenced against the themes for which they are available.

Cluster/Remote Access

Setup Remote Access Key

This feature can be used to generate an access key. This access key can be used for automatic account creation scripts, external billing software, and allowing servers in your DNS cluster to exchange records.

Account Information

List Accounts

This feature will list all of the accounts hosted under your WHM Account.

List Parked Domains

This feature displays a list of parked domains under your WHM Account.

List Subdomains

This feature displays a list of subdomains under your WHM Account.

List Suspended Accounts

This feature displays a list of any suspended accounts hosted under your WHM Account.

Search Accounts

This feature allows you to search for accounts and access the List Accounts screen.

View Bandwidth Usage

This feature displays a list, sorted monthwise, that shows you bandwidth utilization by accounts hosted under your WHM Account.

Account Functions (Anchor: accountfunctions)

Create a New Account (Anchor: createaccount)

This feature allows you to create new cPanel accounts.

Force Password Change

This feature allows you to force a user to change his or her password.

Modify Suspended Account Page

This feature allows you to edit the Account Suspended template.

Password Modification

This feature allows you to change passwords for any of your existing cPanel Accounts as well as your WHM Account.

Note

How-to for Password Modification

WHM Password Modification: You may reset your WHM Password from your WHM interface itself, by modifying the password for the main Account. However, you will also have to then update it within the your Control Panel. See details

Skeleton Directory

The skeleton directory exists to let you easily copy the same files into every new account’s public_html and public_ftp directories when the account is created. This feature simply states the location of the skeleton directory.

Suspend/Unsuspend an Account (Anchor: suspend)

This feature allows you to suspend/unsuspend cPanel accounts.

Terminate an Account (Anchor: terminate)

This feature allows you to terminate cPanel accounts.

Upgrade/Downgrade an Account (Anchor: upgrade)

This feature allows you to change an account's package.

Web Template Editor

This feature allows you to create placeholder web pages.

Multi Account Functions (Anchor: multiaccount)

Modify/Upgrade Multiple Accounts

This feature will allow you to simultaneously change the attributes of multiple accounts.

Terminate Multiple Accounts

This feature allows you to simultaneously terminate multiple accounts.

Themes (Anchor: themes)

Change WHM Theme

This feature allows you to select the theme your WHM interface will use.

Packages (Anchor: package)

Packages are limitations on resources an account is allowed to use. The Packages section provides options of Add a Package, Delete a Package, Edit a Package and Feature Manager.

DNS Functions(Anchor: dns)

Add a DNS Zone

This feature allows you to set up a DNS zone.

Delete a DNS Zone

This feature allows you to delete a DNS zone.

Edit DNS Zone

This feature allows you to edit the records in a domain's DNS zone file.

Edit MX Entry

This feature lets you list destination mail servers, designating a priority value to each.

Edit Zone Templates

The Zone Template Editor will allow you to edit the default zones that are used when creating DNS entries, under a custom DNS setup.

Park a Domain

This feature allows you to park a domain name, pointing it to another domain name hosted under your WHM account..

Reset a DNS Zone

This feature allows you to reset the default values for a selected zone file.

Email

Mail Troubleshooter

This feature will access a mail routing tracer.

cPanel

Branding (Anchor: branding)

This feature allows you to change the look of your users' cPanel interfaces by replacing the default images with your own.

Change Log

This section displays a list of published builds for cPanel & WHM software. The entries include fixes, enhancements, and patches intended to fix known problems.

SSL/TLS (Anchor: digicert)

Generate a SSL Certificate and Signing Request

WHM allows you to generate an SSL certificate for your website.

Install a SSL Certificate and Setup the Domain

This feature allows you to automatically install your SSL certificate and private key in the correct directories.

Manage SSL Hosts

This feature allows you to you share SSL certificates, and manage certificates by domain and user.

Plugins

Change Site's Ip (Anchor: changeip)

This feature allows you to associate a Dedicated/Shared IP Address with an Account.

  1. Click the Change Site's Ip link.

  2. From the Your Accounts box, select the Account for which you wish to modify the associated IP Address.

  3. Select a Dedicated/ Shared IP Address from the Available IPs box.

  4. Click the Change IP button.

Note
  • A Dedicated IP Address can be assigned to only one Account, whereas a Shared IP Address can be assigned to multiple Accounts.

  • Modifying the IP Address for an Account from Dedicated IP Address to Shared IP Address will release the Dedicated IP Address to the pool of available IP Addresses.

Mod Security

The link within this section provides information about mod_security versions and rules.

Softaculous - Instant Installs

From within the Plans section, you can manage Access Control Plans. For each Access Control Plan, you can select the Packages & Users to whom the Access Control Plan will apply and the scripts that you wish offer under it.

Accessing your Reseller Linux Hosting Package

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

Managing your Reseller Linux Hosting package through your Control Panel with
(Anchor: manage)

Note

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

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

  2. Here,

    • Click the Access your cPanel Account link to get automatically logged into your cPanel interface.

    • Click the Access your WHM Account link to get automatically logged into your WHM interface.

Modifying the Password of your cPanel / WHM Interface (Anchor: password)

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

  2. Click the Admin Details link.

  3. Click the Change Password link under Login Details.

  4. Mention a Password of your choice and click the Change Password button to reset your password. This password, alongwith the Username listed in the Admin Details section, can be used to login
    to both the cPanel and WHM interfaces.

Managing your Reseller Linux Hosting Package through an IP Address (Anchor: ip)

Note

This method is typically recommended if you wish to delegate managing your Reseller Linux Hosting package to a Web Designer and have not yet modified your domain
name's Name Servers to the ones recommended by .

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

Retrieving the IP Address and Login Credentials of your Reseller Linux Hosting Package

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

  2. Click the Admin Details link.

  3. Under Login Details, note the IP Address (next to the cPanel URL / WHM URL field) and your Username.

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

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

      OR

    • by changing the password in the Admin Details interface. See details

Managing your Reseller Linux Hosting Package through your Domain Name (Anchor: domain)

Note

This method of accessing the Reseller Linux Hosting package is very similar to the one above and is also recommended when providing access to your Web Designer. The
only difference between the two methods is that, for this to work you should have already modified your domain name's Name Servers to
's. See details

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

Retrieving the Login Credentials of your Reseller Linux Hosting package

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

  2. Click the Admin Details link.

  3. Under Login Details, note the URL (next to the cPanel URL / WHM URL field) for accessing your cPanel interface and it's Username.

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

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

      OR

    • by changing the password in the Admin Details interface. See details

Delete Dedicated IP

Description

Deletes the specified dedicated IP(s) of the Reseller Linux Hosting 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 for which the specified dedicated IP(s) to be deleted.
ips Array of Strings Required Dedicated IP(s) you want to delete.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/resellerhosting/linux/us/delete-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&ips=0.0.0.0&ips=1.1.1.1

UK Server


https://test.httpapi.com/api/resellerhosting/linux/uk/delete-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&ips=0.0.0.0&ips=1.1.1.1

India Server


https://test.httpapi.com/api/resellerhosting/linux/in/delete-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&ips=0.0.0.0&ips=1.1.1.1

Turkey Server


https://test.httpapi.com/api/resellerhosting/linux/tr/delete-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&ips=0.0.0.0&ips=1.1.1.1

Response

Returns a map of the execution details of the deleting dedicated IP(s) operation.

Get Customer Pricing

Description

Use this method to get details of the pricing for the Reseller Linux Hosting plans.

Response

Returns a map with the prices of the Reseller Linux Hosting plans along with the prices of the other products.

The response structure for the Reseller Linux Hosting product will be:


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

Example:

US Server


"resellerhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"resellerhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"resellerhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"resellerhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Get Modify/Upgrade Price

Description

Gets the applicable modify/upgrade price for a particular Reseller Linux Hosting 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 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

US Server


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

UK Server


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

India Server


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

Turkey Server


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

Response

Returns the applicable modify/upgrade price for a particular Reseller Linux Hosting 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

Search Orders

Description

Gets a list and details of the Reseller Linux Hosting 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 ID(s) of the Reseller Linux Hosting Order(s) whose details need to be fetched.
reseller-id Array of Integers Optional Reseller Id(s) whose Orders need to be fetched.
customer-id Array of Integers Optional Customer Id(s) whose 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, Deleted, etc.
domain-name String Optional Name of the Domain of the Reseller Linux Hosting Order.
creation-date-start String Optional UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of the Reseller Linux Hosting 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

US Server


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

UK Server


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

India Server


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

Turkey Server


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

Response

Returns the list of the Reseller Linux Hosting Orders which match the search criteria.

Get Order Id

Description

Gets the associated Reseller Linux Hosting 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

US Server


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

UK Server


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

India Server


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

Turkey Server


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

Response

Returns the associated Reseller Linux Hosting Order ID (Integer) of the domain name.

Get Plan Details

Description

Use this method to get details of your plans.

Response

Returns the details of the plans of the Reseller Linux Hosting product along with the plan details of other Products of the reseller.

Example:

The response structure for the Reseller Linux Hosting product will be:

US Server


resellerhosting

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

UK Server


resellerhostinglinuxuk

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

India Server


resellerhostinglinuxin

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Turkey Server


resellerhostinglinuxtr

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Get Details

Description

Gets the details of an existing Reseller Linux Hosting 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 for which the details to be fetched.

HTTP Method

GET

Example Test URL Request

US Server


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

UK Server


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

India Server


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

Turkey Server


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

Response

Returns the details of an existing Reseller Linux Hosting Order.

Delete

Description

Deletes an existing Reseller Linux Hosting 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 which is to be deleted.

HTTP Method

POST

Example Test URL Request

US Server


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

UK Server


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

India Server


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

Turkey Server


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

Response

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