Look up a License ID — XMLlookup.cgi

This Manage2 function allows you to retrieve the license ID associated with an IP address.

Variables

Input

The following variable is required:

• ip (string) — The IP address that corresponds to the license ID you wish to retrieve.

The following variables are optional:

• packageid (integer) — The package that corresponds to the license ID you wish to retrieve.
• all (boolean) — Whether to return all licenses currently associated with the specified IP address. (This parameter is intended for use with systems that have multiple licenses on a single IP address.)
  • 1 — yes
  • 0 — no (returns the first active license on the IP address)

Output

• licenseid (string, or list if all=1 ) — The license ID(s) associated with the IP address.
  • Example: 0001
• reason (string) — Information about the license ID lookup.
• status (boolean) — Whether the lookup was successful.
  • 1 — The license was successfully looked up.
  • 0 — The license does not exist.
  • -1 — The request failed due to an error.
• version (float) — Internal information used by the Manage2 API.

Examples

Using HTTP (direct API call)

Calling http://manage2.cpanel.net/XMLlookup.cgi?ip=127.0.0.1;all=1 in a web browser will produce XML output similar to the following:

<XMLlookup reason="OK" status="1">
      <licenseid>5388377</licenseid>
      <licenseid>5388378</licenseid>
  </XMLlookup>

Calling the function using the URL above will return XML data by default. To change the output format that will be returned, use either of the following URLs:

• JSON — http://manage2.cpanel.net/XMLlookup.cgi?output=json&ip=127.0.0.1
• YAML — http://manage2.cpanel.net/XMLlookup.cgi?output=yaml&ip=127.0.0.1

For more information about each of these output types, visit our Choosing an Output Type documentation.

Using a Perl module

The following is an example of a Perl module that will call XMLlookup.cgi. You can use this module to pass input variables to a Manage2 API function. You may need to edit the example below to suit your needs.

use cPanelLicensing;
  my $cpl = cPanelLicensing->new(user => $user, pass => $pass);
  my $licenses = $cpl->fetchLicenseId(ip => $ip);
  print "@$licenses\n";

In this example:

• $ip is meant to stand for the IP address that corresponds to the license ID you wish to retrieve.
• $user and $pass are meant to stand for your Manage2 account credentials.

You can learn more about using a Perl module to call API functions.

Using a PHP class

The following is an example showing how to call the cPanelLicensing PHP class. You can use this class to pass input variables to the Manage2 API using a few short calls.

<?php
  include("cpl.inc.php");
  $cpl = new cPanelLicensing($user, $pass);
  $licenses = $cpl->fetchLicenseId(array("ip" => $ip));
?>

In this example:

• $ip is meant to stand for the IP address that corresponds to the license ID you wish to retrieve.
• $user and $pass are meant to stand for your Manage2 account credentials.

You can learn more about using a PHP class to call API functions.