Using API in perl scripts on virtual hostings

You'll need to use the following format for cPanel API2 calls:

Code:

https://myhost:2083/cpsess1471282806/xml-api/cpanel?cpanel_xmlapi_module=MODULE&cpanel_xmlapi_func=FUNC&cpanel_xmlapi_apiversion=2

So for example, to add an addon domain, use:

Code:

https://myhost.com:2083/cpsessxxx/xml-api/cpanel?cpanel_xmlapi_module=AddonDomain&cpanel_xmlapi_func=addaddondomain&cpanel_xmlapi_apiversion=2&newdomain=addondomain.com&subdomain=addondomain.domain.com&dir=/home/user/addondomain

Here are the docs for AddonDomain::addaddondomain:

ApiAddonDomain < ApiDocs/Api2 < TWiki



I don't know what API::Cpanel is but it is not an official cPanel method to connect to their API.


If you're running the perl script on the cPanel server, you can just load up Cpanel::AddonDomain with:

Code:

BEGIN{
  unshift(@INC, '/usr/local/cpanel');
}
use Cpanel::AddonDomain ();

If you're not on a cPanel server, I'd recommend using Net::SSLeay and HTTP::Request::Common to craft your API requests.

 

DmitPet,

I dont' know why you're receiving that error, but you can find out the raw response like so:

Code:

my $cp = cPanel::PublicAPI->new(
       'user' => $username,
       'pass' => $password,
       'host' => $host,
       'debug' => 1,
     );

 my $result = $cp->cpanel_api2_request('cpanel',
    {
        'module' => 'AddonDomain',
        'func' => 'addaddondomain',
    },
    {
        'dir' => "public_html/$domain",
        'newdomain' => $domain,
        'subdomain' => $subdomain,
    },
    'xml'
  );

# for illustration puposes
print Dumper $result;

By adding one more input argument to cpanel_api2_request, being either 'json' or 'xml', it will make the query with that requested format and return the raw response.

Normally, the queries are made with the 'json' format and then parsed and returned as a hash ref...which, if you're getting a valid response, is great; It would let you avoid (or at least provide a alternative to) the Dumper and the string pattern matching...you can just look with the data->result container

Example output from the above code block:

Code:

$VAR1 = '<?xml version="1.0" ?>
  <cpanelresult>
    <apiversion>2</apiversion>
    <data>
      <reason>Deleted domain: tester.blah.net
Bind reloading on myserver using rndc zone: [blah.net]
The subdomain, tester.blah.net has been removed.</reason>
      <result>1</result>
    </data>
    <event>
      <result>1</result>
    </event>
    <func>addaddondomain</func>
    <module>AddonDomain</module>
    <postevent>
      <result>1</result>
    </postevent>
    <preevent>
      <result>1</result>
    </preevent>
  </cpanelresult>
';

Regards,
-DavidN

 

DmitPet,

That is strange. What response do you get if you manually use a browser?

Manual XML/JSON API queries via browser

1. Login to cPanel in a browser
2. Go to the address bar of your browser
3. Erase everything after the cPanel token (cpsessxxxxx)
4. Manually add the XML/JSON API URL and query parameters
   
   Example:

   Code:

   https://myhost.com:2083/cpsessxxx/xml-api/cpanel?cpanel_xmlapi_module=AddonDomain&cpanel_xmlapi_func=addaddondomain&cpanel_xmlapi_apiversion=2&newdomain=addondomain.com&subdomain=addondomain.domain.com&dir=/home/user/addondomain

5. Send request in browser ('go' button, return key, etc)

-DavidN

 

Just a few quick comments. I'd definitely recommend using a reference for the data that you get back from PublicAPI as shown in David's code. If you're expecting an array and the data comes back as a scalar (which it should) or hash, you'll have problems. With a reference, you can check the datatype with ref() and then act accordingly:

Code:

my $result = $cp->cpanel_api2_request('cpanel',

The second is that I've also had issues acting after AddonDomain::addaddondomain because the function may give a result => 0 when it actually fails. Rather than checking for specific text to see if it has completed, you can check the list of Addons with AddonDomain::listaddondomains to see if the domain you expected to be added was. This will be more future proof, especially if cPanel allows for these error messages to be translated at some point in the future.


Finally, I'd recommend parsing the output from PublicAPI with XML::Simple before acting on it. You should be looking for some key parts of the response each time as if for some reason the output includes error messages or debug information, your code may not function as expected in the future. XML::Simple::XMLin($result) should load up the response into a hashref for you.