Account Functions

The below functions allow you to view, setup, modify, and terminate accounts setup within your Reseller Central.

getAccounts

Retieve a list of the accounts you have created in your Reseller Central.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
• Optional Parameters:
  • filters (string) - string of advanced filtering options
    • search (string) - domain of the account to search for
    • status (int) - status of account, 1 = active, 2 = suspended
    • pack_id (int) - id of the package set on accounts to search for
• sort (string) - string of advanced sorting options
• Example: https://cp.hostnine.com/api/?module=getAccounts&api_key=mygeneratedapikey
       &filters=%search:mydomainhere.com%status:1
• Return: Show

  {
       "filtersstr":"%search:mydomainhere.com%status:1",
       "sortstr":"",
       "filters":{
            "search":"mydomainhere.com",
            "status":"1"
       },
       "sort":[],
       "accounts": "1",
       "sql":[
            {
                 "domain_id":"311813",
                 "user_id":"803",
                 "node_id":"142",
                 "pack_id":"3068",
                 "domain":"mydomainhere.com",
                 "username":"myuser",
                 "password":"myaccountpassword",
                 "time_created":"1341531462",
                 "ip":"74.86.183.206",
                 "ns1":"ns1.speedydns.net",
                 "ns2":"ns2.speedydns.net",
                 "ns3":"ns3.speedydns.net",
                 "ns4":null,
                 "quota":"1000",
                 "bandwidth":"0",
                 "total_disk":"0",
                 "total_bw":"0",
                 "os":"1",
                 "status":"1",
                 "sship_id":"0",
                 "dedip_id":"0",
                 "hostname":"uscentral3",
                 "location":"Central",
                 "flag":"us",
                 "iptype":"shared",
                 "quota_percent":0,
                 "rquota":"1 GB",
                 "bw_percent":0,
                 "rbandwidth":".",
                 "rtotal_disk":"0 B",
                 "rtotal_bw":"0 B"
            }
       ]
  }

createAccount

Create a new account within your Reseller Central using the options provided.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
  • domain (string) - primary domain of the new account
  • username (string) - username of the new account
    • note: must be 3-8 characters, starting with a letter, cannot contain the word 'test'
  • password (string) - password to set for the new account control panel
  • location (string) - location to create the new account
  • Use one of the following:
    • pack_id (int) - id of the package to set for the new account
    • package (string) - name of the package to set for the new account
• Optional Parameters:
  • contact (string) - contact email for the new account control panel
  • skeleton (string) - the name of your skeleton package to be used with new accounts
• Example: https://cp.hostnine.com/api/?module=createAccount&api_key=mygeneratedapikey
       &domain=mydomainhere.com&username=myuser&password=myaccountpassword
       &location=(US)%20Central&package=MyGoldPackage
• Return: Show

  {
       "success":"true",
       "result":"Successfully created account.",
       "account":[
            {
                 "domain":"mydomainhere.com",
                 "ip":"12.34.56.78"
            }
  }

viewAccount

View the details of an account setup within your Reseller Central.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
  • Use one of the following:
    • domain_id (int) - primary domain id of the account
    • domain (string) - primary domain of the account
• Example: https://cp.hostnine.com/api/?module=viewAccount&api_key=mygeneratedapikey&domain=mydomainhere.com
• Return: Show

  {
       "success":"true",
       ,"result":"Successfully located domain details.",
       "node":"uswest12",
       "domain_id":"311803",
       "user_id":"803",
       ""node_id":"190",
       "pack_id":"3067",
       "domain":"mydomainhere.com",
       "username":"myuser",
       "password":"mypasswordhere",
       "time_created":"1341526908",
       "ip":"174.36.159.39",
       "ns1":"ns1.speedydns.net",
       "ns2":"ns2.speedydns.net",
       "ns3":"ns3.speedydns.net",
       "ns4":null,
       "quota":"2500",
       "rquota":"2.5 GB",
       "quota_percent":0,
       "bandwidth":"15000",
       "rbandwidth":"15 GB",
       "bandwidth_percent":0,
       "total_disk":"0",
       "rtotal_disk":"0 B",
       "total_bw":"0",
       "rtotal_bw":"0 B",
       "os":"1",
       "status":"1",
       "sship_id":"0",
       "dedip_id":"0",
       "processor":"",
       "rmemory":"12002",
       "memory":"12 GB",
       "hdd":"",
       "http":"UP",
       "mysql":"UP",
       "ftp":"UP",
       "pop3":"UP",
       "smtp":"UP",
       "ssh":"UP",
       "distro":"CloudLinux Server release 5.8",
       "php_ver":"5.3.13",
       "mysql_ver":"5.1.63",
       "perl_ver":"5.8.8",
       "apache_ver":"2.2.22",
       "cpanel_ver":"11.32.3",
       "path_to_php":"\/usr\/local\/bin\/php",
       "path_to_perl":"\/usr\/local\/bin\/perl",
       "location":"(US) West",
       "iptype":"shared",
       "package_name":"xodustech_Premium",
       "max_ftp":"unlimited",
       "max_sql":"unlimited",
       "max_email":"unlimited",
       "theme":"x3"
  }

modifyAccount

Modify the hosting options of an account within your Reseller Central.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
  • Use one of the following:
    • domain_id (int) - primary domain id of the account
    • domain (string) - primary domain of the account
• Optional Parameters:
  • newdomain (string) - new domain name for the account
  • username (string) - new username for the account
  • password (string) - new password for the account
  • quota (int) - new quota limit for the account
  • bandwidth (int) - new bandwidth limit for the account
  • theme (string) - new control panel theme for the account
  • ns1 (string) - new first nameserver for the account
  • ns2 (string) - new second nameserver for the account
  • Optionally one of the following:
    • pack_id (int) - id of the package to set for the account
    • package (string) - name of the package to set for the account
• Example: https://cp.hostnine.com/api/?module=modifyAccount&api_key=mygeneratedapikey
       &domain=mydomainhere.com&newdomain=mynewdomainhere.com
• Return: Show

  {
       "success":"true",
       "result":"Successfully modified account."
  }

changeAccountPassword

Change the password of an account's control panel within your Reseller Central.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
  • password (string) - password to set for the account control panel
  • Use one of the following:
    • domain_id (int) - primary domain id of the account
    • domain (string) - primary domain of the account
• Example: https://cp.hostnine.com/api/?module=changeAccountPassword&api_key=mygeneratedapikey
       &domain=mydomainhere.com&password=mynewaccountpassword
• Return: Show

  {
       "success":"true",
       "result":"The password has been successfully updated"
  }

changeAccountPackage

Change the package currently set on an account setup within your Reseller Central. This module is equivilent to using the Upgrade/Downgrade Account feature within your Reseller Central.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
  • Use one of the following:
    • domain_id (int) - primary domain id of the account
    • domain (string) - primary domain of the account
  • Use one of the following:
    • pack_id (int) - id of the package to set for the account
    • package (string) - name of the package to set for the account
• Example: https://cp.hostnine.com/api/?module=changeAccountPackage&api_key=mygeneratedapikey
       &domain=mydomainhere.com&package=MyGoldPackage
• Return: Show

  {
       "success":"true",
       "result":"The package has been successfully updated to MyGoldPackge"
  }

suspendAccount

Suspend an account's hosting service that is setup within your Reseller Central.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
  • reason (string) - the reason for the suspension
  • Use one of the following:
    • domain_id (int) - primary domain id of the account
    • domain (string) - primary domain of the account
• Example: https://cp.hostnine.com/api/?module=suspendAccount&api_key=mygeneratedapikey
       &domain=mydomainhere.com&reason=Suspended%20for%20nonpayment
• Return: Show

  {
       "success":"true",
       "result":"This domain has been suspended successfully."
  }

unsuspendAccount

Unsuspend and restore an account's hosting service that is setup within your Reseller Central.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
  • Use one of the following:
    • domain_id (int) - primary domain id of the account
    • domain (string) - primary domain of the account
• Example: https://cp.hostnine.com/api/?module=unsuspendAccount&api_key=mygeneratedapikey&domain=mydomainhere.com
• Return: Show

  {
       "success":"true",
       "result":"This domain has been unsuspended successfully."
  }

terminateAccount

Terminate and remove an account's hosting service that is setup within your Reseller Central.

• Required Parameters:
  • api_key (string) - Reseller Central generated API Key
  • Use one of the following:
    • domain_id (int) - primary domain id of the account
    • domain (string) - primary domain of the account
• Example: https://cp.hostnine.com/api/?module=terminateAccount&api_key=mygeneratedapikey&domain=mydomainhere.com
• Return: Show

  {
       "success":"true",
       "result":"The account, mydomainhere.com, has been successfully terminated."
  }