Remote Access Key: Difference between revisions
Docs admin (talk | contribs) m Docs admin moved page What is a Remote Access Key? to Remote Access Key without leaving a redirect |
Docs admin (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
WHM provides you with a Remote Access Key for allowing 3rd party scripts to access your WHM on Reseller, Virtual, or Dedicated plans. You can allow external scripts to perform a multitude of tasks from account creation, account termination, account suspensions and much more. | |||
Many popular scripts which integrate and communicate with cPanel/WHM require your Remote Access Key for accessing your server. The popular billing software WHMCS is one such example. WHMCS allows for automatic signups, automatic account creation, and configuration of hosting packages. WHMCS is only one such example, there are many scripts out there which allow you to perform WHM tasks externally via use of the Remote Access Key. | |||
In addition to prewritten scripts, if you are familiar with a scripting language such as PHP or Perl, you can custom code your own web-based applications. | |||
A word of warning, use of the Remote Access Key in custom applications requires extensive familiarity with your scripting language of choice. | |||
Luckily, cPanel already provides you with the API needed for communicating with your WHM interface. Documentation regarding cPanel's XML API can be found here [http://www.cpanel.net/plugins/xmlapi/| cPanel XML API Documentation] | |||
In combination with your Remote Access Key, cPanel's XML API functions allow you to remotely or automatically perform WHM tasks. | |||
The actual implementation of cPanel's API is beyond the scope of our knowledgebase. However, we have included some great utilities for getting familiar with cPanel's XML API functions. | |||
{{Related Topics}} | |||
[[Generate a Remote Access Key]] | |||
[http://forums.cpanel.net/showthread.php?t=76995|cPanel Forum Thread Discussing XML API] | |||
[http://forums.cpanel.net/showpost.php?p=322538|XML API Code Sample] | |||
[http://us2.php.net/manual/en/book.xml.php|php.net XML Parser] | |||
[[Category:WHM (Web Host Manager)]] | |||
Revision as of 10:23, 5 October 2012
WHM provides you with a Remote Access Key for allowing 3rd party scripts to access your WHM on Reseller, Virtual, or Dedicated plans. You can allow external scripts to perform a multitude of tasks from account creation, account termination, account suspensions and much more.
Many popular scripts which integrate and communicate with cPanel/WHM require your Remote Access Key for accessing your server. The popular billing software WHMCS is one such example. WHMCS allows for automatic signups, automatic account creation, and configuration of hosting packages. WHMCS is only one such example, there are many scripts out there which allow you to perform WHM tasks externally via use of the Remote Access Key.
In addition to prewritten scripts, if you are familiar with a scripting language such as PHP or Perl, you can custom code your own web-based applications.
A word of warning, use of the Remote Access Key in custom applications requires extensive familiarity with your scripting language of choice.
Luckily, cPanel already provides you with the API needed for communicating with your WHM interface. Documentation regarding cPanel's XML API can be found here cPanel XML API Documentation
In combination with your Remote Access Key, cPanel's XML API functions allow you to remotely or automatically perform WHM tasks.
The actual implementation of cPanel's API is beyond the scope of our knowledgebase. However, we have included some great utilities for getting familiar with cPanel's XML API functions.
Related Topics